Skip to main content
PATCH
/
api
/
v1
/
webhook_subscriptions
/
{id}
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "name": "<string>",
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "headers": [
    "<string>"
  ],
  "isActive": true,
  "maxRetries": 3,
  "timeoutSeconds": 30,
  "tenant": "https://example.com/",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastTriggeredAt": "2023-11-07T05:31:56Z",
  "totalDeliveries": 123,
  "successfulDeliveries": 123,
  "failedDeliveries": 123,
  "description": "<string>",
  "metadata": [
    "<string>"
  ]
}

Path Parameters

​
id
string
required

WebhookSubscription identifier

Body

application/merge-patch+json

The updated WebhookSubscription resource

​
name
string
required
Maximum 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 updated

​
name
string
required
Maximum length: 255
​
url
string<uri>
required
​
eventTypes
string[]
required
​
@context
​
@id
string
​
@type
string
​
id
integer
​
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

​
tenant
string<iri-reference>
Example:

"https://example.com/"

​
createdAt
string<date-time>
​
updatedAt
string<date-time> | null
​
lastTriggeredAt
string<date-time> | null
​
totalDeliveries
integer
​
successfulDeliveries
integer
​
failedDeliveries
integer
​
description
string | null
​
metadata
string[] | null
⌘I