Skip to main content
POST
Register an endpoint

Authorizations

Authorization
string
header
required

A workspace API key with the outbound_webhooks:write scope, sent as Authorization: Bearer <key>.

Body

application/json
selected_event_types
string[]
required

The event types to send, such as app.created.v1. Each type is a separate version.

Required array length: 1 - 64 elements
target_url
string
required

The HTTPS URL that receives events. It must resolve to public addresses, can't contain credentials, and must answer directly: redirects aren't followed.

Maximum string length: 2048
description
string
default:""

A note for your own reference, up to 200 characters.

Maximum string length: 200

Response

Successful Response

The endpoint and the result of its activation test.

activated
boolean
required

Whether the endpoint passed the test and is active.

endpoint
EndpointResponse · object
required
Example:
detail
string
default:""

A sentence explaining the result. Not a stable contract.

failure_category
string | null

Why the test failed: timeout, transport (no connection), server_error (5xx), client_error (4xx, or a 2xx without the challenge), redirect, ssrf_rejected (the URL resolved to a non-public address) or internal. Null on success.

http_status
integer | null

The status your endpoint answered with. Null when it didn't answer.