Skip to main content
POST
/
integrations
/
api
/
v1
/
webhooks
/
endpoints
Create a webhook endpoint
curl --request POST \
  --url https://www.closient.com/integrations/api/v1/webhooks/endpoints/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "description": "",
  "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

Body

application/json

Request body for creating a webhook endpoint.

​
url
string
required

HTTPS URL to receive webhook deliveries.

​
description
string
default:""

Human-readable label.

Maximum string length: 255
​
event_types
string[]

Event types to subscribe to, e.g. ['offer.updated'].

​
is_active
boolean
default:true

Whether the endpoint is active.

Response

201 - application/json

Created

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.