Skip to main content
POST
/
v1
/
webhooks
/
endpoints
Create webhook endpoint
curl --request POST \
  --url https://api.hyperline.co/v1/webhooks/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Production webhook endpoint",
  "url": "https://example.com/webhook",
  "secret": "<string>",
  "rate_limit": 123,
  "event_types": [
    "customer.created",
    "customer.updated"
  ]
}'
{
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "description": "Production webhook endpoint",
  "url": "https://example.com/webhook",
  "rate_limit": 123,
  "event_types": [
    "customer.created",
    "customer.updated"
  ],
  "created_at": "2024-01-20T16:04:11Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string<uri>
required

Webhook endpoint URL.

Example:

"https://example.com/webhook"

​
description
string

Webhook endpoint description.

Example:

"Production webhook endpoint"

​
secret
string

Webhook endpoint verification secret (base64 encoded random bytes). If not defined, a secret is automatically generated and only accessible in the UI.

​
rate_limit
number

Webhook rate limit (per second).

​
event_types
enum<string>[]

Webhook event types filter. If not defined, all event messages will be sent.

Example:
["customer.created", "customer.updated"]

Response

201 - application/json
​
id
string
required

Webhook endpoint ID.

Example:

"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2"

​
description
string
required

Webhook endpoint description.

Example:

"Production webhook endpoint"

​
url
string<uri>
required

Webhook endpoint URL.

Example:

"https://example.com/webhook"

​
rate_limit
number | null
required

Webhook rate limit (per second).

​
event_types
enum<string>[] | null
required

Webhook event types filter. If not defined, all event messages will be sent.

Example:
["customer.created", "customer.updated"]
​
created_at
string<date-time>
required

Webhook creation date.

Example:

"2024-01-20T16:04:11Z"

⌘I