Create Webhook Endpoint

Register a new webhook endpoint to receive delivery status updates.

Security:

• Webhooks are signed with HMAC-SHA256
• Verify signature using X-Hixbe-Signature header
• Secret is provided in the response

Retry Logic:

• Failed deliveries are retried with exponential backoff
• Maximum 3 retry attempts
• Webhook disabled after 10 consecutive failures

Payload Example:

{
  "event": "message.delivered",
  "message_id": "msg_abc123",
  "to": "8801712345678",
  "status": "delivered",
  "delivered_at": "2026-01-15T10:30:15Z"
}

POST /webhooks

Create webhook endpoint

cURL

curl --request POST \
  --url https://api.hixbe.com/certify/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Hixbe-Version: <hixbe-version>' \
  --data '
{
  "url": "https://api.example.com/webhooks/hixbe",
  "events": [
    "credential.issued",
    "credential.revoked",
    "credential.verified"
  ]
}
'

201

{
  "id": "wh_1234567890abcdef",
  "url": "https://api.example.com/webhooks/hixbe"
}

Authorizations

Authorization · string · header · required

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

Headers

Hixbe-Version · string · required

API version in YYYY-MM-DD format

Example:

"2026-01-01"

Body

application/json

Request payload for creating a webhook endpoint

url · string<uri> · required

HTTPS URL where webhook events will be sent

Example:

"https://api.example.com/webhooks/hixbe"

events · enum<string>[] · required

Array of event types to subscribe to

Available options: credential.issued, credential.revoked, credential.verified

Example:

[
  "credential.issued",
  "credential.revoked",
  "credential.verified"
]

Response

201

application/json

Webhook endpoint created successfully

Response containing webhook endpoint information

id · string

Unique identifier for the webhook endpoint

Example:

"wh_1234567890abcdef"

url · string

URL where webhook events are sent

Example:

"https://api.example.com/webhooks/hixbe"