Sign inGet an API key

Create webhook

Registers a URL that receives task events as they happen, so you do not have to poll. Deliveries are signed; the signing secret is returned here and nowhere else.

POST/webhook
AuthAPI keyorOAuth tokenHow to send it

Registers an endpoint that Mynth POSTs to when a task settles. Deliveries are signed with the wbs_ secret in this response. The API returns it only here, so store it now. The dashboard also shows it on the endpoint's page.

Webhooks has the signature check, events, and sources. Webhook payloads has the body of each event.

Request body#

eventsarray | stringrequired

The events to send to the webhook. When 'all', all events will be sent to the webhook.

"all"
urlstringrequired

The URL to send the webhook to. Must be a valid URL.

oauthEnabledboolean

Whether tasks authenticated with OAuth (playground and CLI sessions) deliver to this webhook.

default false
enabledboolean

Whether the webhook is enabled. When disabled, no events will be sent to the webhook.

default true
apiKeyIdsstring[] | null

API keys this webhook is scoped to. When empty or null, every API key delivers to it.

≤ 1000 items

Response#

201Webhook created

dataobjectrequired

Errors#

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.