Skip to main content
POST
/
v1
/
subscriptions
Create (upsert) an auto-delivery subscription
curl --request POST \
  --url https://api.webhook.co/v1/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceEndpointId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destinationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "requireVerified": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceEndpointId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destinationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "requireVerified": true,
  "enabled": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
sourceEndpointId
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)$
​
destinationId
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)$
​
provider
string | null
Required string length: 1 - 80
​
eventTypes
string[]
Maximum array length: 100
Required string length: 1 - 200
​
requireVerified
boolean

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)$
​
sourceEndpointId
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)$
​
destinationId
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)$
​
provider
string | null
required
​
eventTypes
string[]
required
​
requireVerified
boolean
required
​
enabled
boolean
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required