The endpoint's transformation set

Every rule on the endpoint's forward destination in the order it runs (rules is empty when none is set), the set limit, and whether the plan includes transformations. Each delivery runs the enabled rules top to bottom; a rule applies when its own when matches and sees the result of the rules before it.

GET
/api/v1/endpoints/{endpointId}/transformations
AuthorizationBearer <token>

API key in the Authorization header: Authorization: Bearer wv_live_…. Keys are created on the API keys page in the app, shown once, and scoped to your workspace. X-Api-Key: wv_live_… is accepted as a fallback for tools that can't set Authorization.

In: header

Path Parameters

endpointId*string

The endpoint id (also the capture token in its URL).

Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{
  "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
  "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  "destinationUrl": "string",
  "rules": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "position": 0,
      "name": "string",
      "enabled": true,
      "disabledReason": "string",
      "condition": "string",
      "rule": {
        "version": 1,
        "name": "strip PII, flatten invoice",
        "when": {
          "all": [
            {
              "path": "body.type",
              "op": "startsWith",
              "value": "invoice."
            }
          ]
        },
        "steps": [
          {
            "op": "keep",
            "paths": [
              "body.id",
              "body.type",
              "body.data.object"
            ]
          },
          {
            "op": "rename",
            "from": "body.data.object.id",
            "to": "body.invoiceId"
          },
          {
            "op": "redact",
            "paths": [
              "body.data.object.customer_email"
            ],
            "with": "***"
          },
          {
            "op": "set",
            "path": "headers.X-Relayed-By",
            "value": "webhookvault"
          },
          {
            "op": "template",
            "path": "body.summary",
            "template": "{{body.type}} {{body.invoiceId}}"
          }
        ]
      },
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "maxRules": 0,
  "featureInPlan": true,
  "schemaUrl": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "traceId": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "traceId": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "traceId": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "traceId": "string"
}

On this page