Skip to main content
POST
/
api
/
v1
/
webhook_subscriptions
/
{id}
/
test
Error
A valid request URL is required to generate request examples
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>"
}

Path Parameters

​
id
string
required

WebhookSubscription identifier

Body

The new WebhookSubscription resource

​
name
string
required
Maximum string length: 255
​
url
string<uri>
required
​
eventTypes
string[]
required
​
secret
string | null
​
headers
string[] | null
​
isActive
boolean
default:true
Example:

true

​
maxRetries
integer
default:3
Required range: 0 <= x <= 10
Example:

3

​
timeoutSeconds
integer
default:30
Required range: 1 <= x <= 300
Example:

30

​
description
string | null
​
metadata
string[] | null

Response

WebhookSubscription resource created

​
@context
​
@id
string
​
@type
string