v2

latestSwagger 2.02026-08-08121119168.6 KB

Webhooks

Get a specific webhook

Returns a single webhook by ID. Receiver credentials and the signing secret are never included.

get/v1/webhooks/{id}

Path parameters

idinteger required

Numeric webhook ID.

Response

Get a specific webhook

idinteger required

Unique numeric webhook ID.

namestring required

Label for the webhook, shown on the dashboard.

urlstring required

Destination URL. May contain {{VARIABLES}}, which are substituted at delivery time.

http_methodstring required

HTTP method used to deliver: POST, PUT or PATCH.

failure_onlyboolean required

When true, only failed tests trigger a delivery.

alert_typesstring required

Which grid the test ran on: ALL, VIRTUAL (VM) or REAL (physical device).

name_filterstring required

Glob matched against the test name, falling back to the build identifier. Empty means every test.

auth_typestring required

How the request authenticates against your endpoint: NONE, BASIC or BEARER. The credentials themselves are never returned.

headersobject[] required

Custom request headers, each { "key": ..., "value": ... }. Values support {{VARIABLES}}.

paramsobject[] required

Custom query parameters appended to the URL, each { "key": ..., "value": ... }.

payload_templatestring required

Custom JSON body template. Empty means the default TestingBot payload is sent.

created_atstring date-time required

When the webhook was created.

updated_atstring date-time required

When the webhook was last changed.

signing_secretstring required

Secret used to verify the X-TestingBot-Signature header. Only present when the webhook is created or its secret is rotated; store it then, because it is never returned again.