Webhooks

Get webhook route information

Retrieve webhook route content and information. Credentials are masked: stored passwords, the credentials in any proxy or webhook URL, and the values of custom webhook headers all read back as "******". A masked value is not the stored one - leave the field out of an update rather than writing it back, otherwise the mask replaces the credential.

get/v1/webhookRoutes/webhookRoute/{webhookRoute}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/webhookRoutes/webhookRoute/{webhookRoute}
  • Auth: HTTP bearer

Path parameters

webhookRoutestring required

Webhook ID

Example:example

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the webhook route, including its filter and transform functions.

idstring required

Webhook ID

namestring required

Name of the route

descriptionstring

Optional description of the webhook route

createdstring date-time

The time this route was created

updatedstring date-time

The time this route was last updated

enabledboolean

Is the route enabled

targetUrlstring

Target URL that will receive webhook notifications via POST requests

tcountinteger

How many times this route has been applied

vinteger

Internal version counter, increased on every update

Example response

{
  "id": "AAABgS-UcAYAAAABAA",
  "name": "Send to Slack",
  "description": "Something about the route",
  "created": "2021-02-17T13:43:18.860Z",
  "updated": "2021-02-17T13:43:18.860Z",
  "enabled": true,
  "targetUrl": "https://api.example.com/email/webhooks",
  "tcount": 123,
  "v": 1,
  "webhookErrorFlag": {
    "message": "Request failed with status 500"
  },
  "customHeaders": [
    {
      "key": "Authorization",
      "value": "Bearer <token>"
    }
  ],
  "content": {
    "fn": "return true;",
    "map": "payload.ts = Date.now(); return payload;"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.