Webhooks
List webhook routes
List custom webhook routes. 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
Request
- Base URL: https://your-emailengine-host
- URL: https://your-emailengine-host/v1/webhookRoutes
- Auth: HTTP bearer
Query parameters
pageinteger
Page number (zero indexed, so use 0 for first page)
pageSizeinteger
How many entries per page
Example:20
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 a page of custom webhook routes.
Example response
{
"total": 120,
"pages": 24,
"webhooks": [
{
"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,
"webhookErrorFlag": {
"message": "Request failed with status 500"
},
"customHeaders": [
{
"key": "Authorization",
"value": "Bearer <token>"
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.