Set webhook configuration

PUT

/v1/webhook

curl --request PUT \
  --url https://example.com/v1/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example" }'

Authorizations

• api_key

Request Body^required

Media typeapplication/json

object

url

required

string

Example^generated

{
  "url": "example"
}

Responses

200

Webhook set/replaced; secret returned once

Media typeapplication/json

object

secret

required

string

url

required

string

Example^generated

{
  "secret": "example",
  "url": "example"
}

400

URL failed SSRF screening

Media typeapplication/json

The JSON body returned for every error response: { "error": "<message>" }, optionally with a stable machine code ({ "error": ..., "code": ... }). The code lets clients map an error to their own localized copy instead of showing the English error string; it is present only for errors we’ve assigned a stable code, and omitted otherwise.

object

code

Stable machine-readable error code for client-side localization, when one is defined for this error (e.g. key_not_found, algorithm_not_on_plan).

string | null

error

required

Human-readable error message. Never contains internal/driver detail.

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Missing or invalid API key

Media typeapplication/json

The JSON body returned for every error response: { "error": "<message>" }, optionally with a stable machine code ({ "error": ..., "code": ... }). The code lets clients map an error to their own localized copy instead of showing the English error string; it is present only for errors we’ve assigned a stable code, and omitted otherwise.

object

code

Stable machine-readable error code for client-side localization, when one is defined for this error (e.g. key_not_found, algorithm_not_on_plan).

string | null

error

required

Human-readable error message. Never contains internal/driver detail.

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Webhooks require the Pro or Scale plan

Media typeapplication/json

The JSON body returned for every error response: { "error": "<message>" }, optionally with a stable machine code ({ "error": ..., "code": ... }). The code lets clients map an error to their own localized copy instead of showing the English error string; it is present only for errors we’ve assigned a stable code, and omitted otherwise.

object

code

Stable machine-readable error code for client-side localization, when one is defined for this error (e.g. key_not_found, algorithm_not_on_plan).

string | null

error

required

Human-readable error message. Never contains internal/driver detail.

string

Example^generated

{
  "code": "example",
  "error": "example"
}