Skip to main content
PATCH
/
integrations
/
api
/
v1
/
webhooks
/
endpoints
/
{endpoint_id}
Update a webhook endpoint
curl --request PATCH \
  --url https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "event_types": [
    "<string>"
  ],
  "is_active": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "signing_secret": "<string>",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "",
  "event_types": [
    "<string>"
  ]
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
endpoint_id
string<uuid>
required

Unique identifier of the webhook endpoint.

Body

application/json

Request body for updating a webhook endpoint.

​
url
string | null

New HTTPS endpoint URL.

​
description
string | null

New description.

Maximum string length: 255
​
event_types
string[] | null

New event type subscriptions.

​
is_active
boolean | null

New active status.

Response

200 - application/json

OK

Response schema for a webhook endpoint (secret masked).

​
id
string<uuid>
required

Endpoint identifier.

​
url
string
required

Endpoint URL.

​
signing_secret
string
required

Signing secret (masked in list/get responses).

​
is_active
boolean
required

Whether the endpoint is active.

​
created_at
string<date-time>
required

When the endpoint was created.

​
updated_at
string<date-time>
required

When the endpoint was last updated.

​
description
string
default:""

Human-readable label.

​
event_types
string[]

Subscribed event types.