Skip to main content
POST
/
webhooks
Create webhook endpoint
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"
  ]
}
'
{
  "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

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"