Skip to main content
POST
/
v1
/
replay-destinations
Register a replay destination (returns a one-time signing secret)
curl --request POST \
  --url https://api.webhook.co/v1/replay-destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "label": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "label": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastValidatedAt": "2023-11-07T05:31:56Z",
  "ordered": true,
  "disabledAt": "2023-11-07T05:31:56Z",
  "signingSecret": "<string>"
}

Authorizations

​
Authorization
string
header
required

A whk_-prefixed API key (opaque; not a JWT).

Body

application/json

url must be a public HTTPS URL (no IP-literal host, credentials, disallowed port, or bare hostname); the server rejects a non-conforming URL with 400 VALIDATION_ERROR.

​
url
string
required
Required string length: 1 - 2048
​
label
string
Required string length: 1 - 200

Response

Success.

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
orgId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
url
string
required
​
label
string | null
required
​
status
enum<string>
required
Available options:
active,
revoked
​
createdAt
string<date-time>
required
​
lastValidatedAt
string<date-time> | null
required
​
ordered
boolean
required
​
disabledAt
string<date-time> | null
required
​
signingSecret
string