Skip to main content
POST
Create webhook endpoint

Body

application/json
name
string
required

Human-readable webhook endpoint name.

Required string length: 1 - 128
Example:

"Frontend callback"

subscribed_events
string[]
required

Webhook event types delivered to this endpoint.

Minimum array length: 1
Example:
url
string
required

HTTPS destination URL that will receive webhook events.

Required string length: 1 - 2048
Example:

"https://example.com/webhooks/nllabs"

Response

Successful Response

Returned ONCE at creation — includes plaintext secret. Never returned again.

consecutive_failures
integer
required

Current consecutive delivery failure count.

created_at
string<date-time>
required

Endpoint creation timestamp.

disabled_at
string<date-time> | null
required

Timestamp when the endpoint was disabled.

last_failure_at
string<date-time> | null
required

Last failed delivery timestamp.

last_success_at
string<date-time> | null
required

Last successful delivery timestamp.

name
string
required

Human-readable webhook endpoint name.

secret
string
required

Plaintext signing secret returned only once.

status
string
required

Endpoint lifecycle status.

subscribed_events
string[]
required

Subscribed webhook event types.

updated_at
string<date-time>
required

Endpoint last update timestamp.

url
string
required

Destination URL.

uuid
string<uuid>
required

Webhook endpoint UUID.