Skip to main content
PATCH
/
v1
/
outbound-webhook-endpoints
/
{outboundWebhookEndpointId}
Update an outbound webhook endpoint
curl --request PATCH \
  --url http://localhost:3001/v1/outbound-webhook-endpoints/{outboundWebhookEndpointId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "subscribedEvents": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "url": "<string>",
  "subscribedEvents": [
    "<string>"
  ],
  "hasSigningSecret": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Headers

​
authorization
string
Minimum string length: 1
​
x-organization-id
string
Minimum string length: 1

Path Parameters

​
outboundWebhookEndpointId
string
required
Minimum string length: 1

Body

application/json
​
name
string
Minimum string length: 1
​
url
string<uri>
​
subscribedEvents
string[]
Minimum array length: 1
Minimum string length: 1
​
status
enum<string>
Available options:
active,
disabled

Response

Default Response

​
id
string
required
​
organizationId
string
required
​
name
string
required
​
url
string<uri>
required
​
subscribedEvents
string[]
required
​
status
enum<string>
required
Available options:
active,
disabled,
deleted
​
hasSigningSecret
enum<boolean>
required
Available options:
true
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required