API Reference
HELP CENTERINTEGRATIONSSTATUS PAGELOGINGET STARTED FREE

Create a webhook endpoint

post
https://webhook.api.sandbox.cleeng.com/endpoints

Creates a new webhook endpoint with auto-generated signing secret.
Note: The signing secret is returned only in this response - store it securely.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Description

ResponseTypeDescription / Example
idstringExample: "ep_2xK9mQ7vB4nR8pL5qM3wY"
urlstringHTTPS URL to receive webhook deliveries.
Example: "https://example.com/webhooks"
namestringHuman-readable endpoint name.
Example: "Production handler"
statusarray of stringsEndpoint status: active, paused
eventsarray of stringsEvent types this endpoint subscribes to
signing:objectSigning configuration including the full secret
  • algorithm
array"HMAC-SHA256"
  • secret
stringFull whsec_-prefixed signing secret. Store securely - not shown again.
  • secretPrefix
stringFirst characters of the signing secret for identification
retry:object
  • maxAttempts
integerMaximum number of delivery attempts (1 initial + retries). Default: 4
metadataobjectAdditional properties
createdAtstring
date-time		Endpoint creation time
updatedAtstring
date-time		Endpoint update time

Body Params
string
required

HTTPS URL to receive webhook deliveries.
Example: "https://example.com/webhooks"

string

Human-readable endpoint name.

≤ 100 characters

Default: ""

events
array of strings
required

Event types this endpoint subscribes to.

≥ 1 items

Example:

#0"subscriptionCreated"

#1"capturePayment"

events*
retry
object
metadata
object

An object with arbitrary metadata.
Key-value metadata (max 10 keys, keys ≤40 chars, values ≤500 chars).

Responses
200

Successful response

Updated 4 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago