Sign in

v2

latestSwagger 2.02026-08-08121119168.6 KB
Webhooks

Create a webhook

Creates a webhook. The response includes signing_secret — the only time it is ever returned — which you use to verify the X-TestingBot-Signature header on deliveries. A team may have at most 5 webhooks.

post/v1/webhooks

Request body

urlstring required

Destination URL. Must be a public http(s) address; private, loopback and link-local hosts are rejected.

namestring

Label for the webhook. Required once the extended webhook columns are present.

http_method'POST' | 'PUT' | 'PATCH'

HTTP method used to deliver. Defaults to POST.

failure_onlyboolean

Deliver only for failed tests. Defaults to false.

alert_types'ALL' | 'VIRTUAL' | 'REAL'

Which grid to report on: ALL, VIRTUAL or REAL.

name_filterstring

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

auth_type'NONE' | 'BASIC' | 'BEARER'

How to authenticate against your endpoint: NONE, BASIC or BEARER.

auth_usernamestring

Username for BASIC auth. Write-only, never returned.

auth_passwordstring

Password for BASIC auth. Write-only, never returned.

auth_tokenstring

Token for BEARER auth. Write-only, never returned.

headersstring[]

Custom request headers, each an object with key and value.

paramsstring[]

Custom query parameters appended to the URL, each an object with key and value.

payload_templatestring

Custom JSON body template using {{VARIABLES}}. Omit to send the default TestingBot payload.

Response

Create a 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.