Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.

Headers

Idempotency-Key
string

Accepted but not used for replay on this operation. Only POST /v1/partner/consultations stores and replays responses by Idempotency-Key.

Pattern: ^[A-Za-z0-9_-]{8,128}$

Body

application/json
url
string
required

The https URL (port 443) that receives deliveries.

Required string length: 1 - 2048
Pattern: \S
events
required

[""] for every event, or a non-empty list of event types; "" cannot be combined with event types and duplicates are ignored. A value that is not a list, a blank entry or an entry longer than 48 characters is refused first with 422 invalid_request; a list of strings that is not ["*"] or a non-empty list of documented event types is then refused with 422 invalid_webhook_events.

Minimum array length: 1
Available options:
*
description
string
default:""

Your description of the endpoint.

Maximum string length: 200
mode
enum<string>

test or live. Defaults to the API key mode; another mode is refused with 422 mode_mismatch.

Available options:
live,
test

Response

The new endpoint and its secret.

id
string<uuid>
required

The webhook endpoint id.

object
enum<string>
required

Always webhook_endpoint.

Available options:
webhook_endpoint
url
string<uri>
required

The https URL (port 443) that receives deliveries.

description
string
required

Your description of the endpoint.

mode
enum<string>
required

test or live, from the API key that created it.

Available options:
live,
test
events
string[]
required

Event types sent to the endpoint, or ["*"] for all of them.

status
enum<string>
required

enabled, disabled or auto_disabled.

Available options:
enabled,
disabled,
auto_disabled
failure_streak
integer
required

Consecutive failed deliveries; reset by a successful delivery or by re-enabling the endpoint.

last_success_at
string<date-time> | null
required

When a delivery to the endpoint last succeeded.

last_failure_at
string<date-time> | null
required

When a delivery to the endpoint last failed.

previous_secret_expires_at
string<date-time> | null
required

After a rotation, when the previous secret stops signing deliveries; otherwise null.

created_at
string<date-time>
required

When it was created.

updated_at
string<date-time>
required

When it last changed.

secret
string
required

The signing secret: whsec_ followed by the standard base64 encoding of 32 random bytes, which are the HMAC key. It is shown only in this response; store it now.