Skip to main content
POST
/
api
/
v1
/
webhook-endpoints
Create a webhook endpoint (returns signing secret once)
curl --request POST \
  --url http://localhost:3001/api/v1/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "url": "https://example.com/hooks/axra",
  "events": [
    "payment.completed",
    "payment.failed"
  ],
  "description": "<string>",
  "apiVersion": "<string>"
}
'
{
  "success": true,
  "data": {
    "endpoint": {
      "id": "<string>",
      "url": "<string>",
      "events": [
        "<string>"
      ],
      "status": "<string>",
      "signingSecretHint": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "businessId": {},
      "partnerId": {},
      "description": {},
      "apiVersion": {}
    },
    "signingSecret": "<string>"
  }
}

Headers

​
x-api-key
string
required

Body

application/json
​
url
string
required
Example:

"https://example.com/hooks/axra"

​
events
string[]
required

Event types to receive, or ["*"] for all supported events.

Example:
["payment.completed", "payment.failed"]
​
description
string
​
apiVersion
string

Optional API version pin for this endpoint

Response

Webhook endpoint created

​
success
boolean
required
Example:

true

​
data
object
required