Create a webhook endpoint

POST /api/v1/admin/webhooks/endpoints prm_notifications_manage

Registers a URL and the events it should receive. Set all_events to subscribe to everything, present and future, instead of naming keys.

Answers 200, not 201, despite creating a record. Do not gate your client on the status code here.

At a glance

Authentication: Staff token or session
Requires permission: prm_notifications_manage Manage notification channels & templates
Rate limit: t_mutate

Parameters

Parameter	Description
`name`required body · string	A label for the endpoint.
`url`required body · string	Where deliveries are POSTed. Validated on save.
`events` body · array	Event keys from the catalogue. Ignored when all_events is true.
`all_events` body · boolean	Subscribe to every event, including ones added in later releases.
`enabled` body · boolean	Defaults to true on create.

Errors

Code	When it is returned
`ERR_VALIDATION`400	an unknown event key, or a URL that does not validate
`ERR_CONFLICT`409	the licensed endpoint ceiling is reached

Request

curl -X POST "$BASE/api/v1/admin/webhooks/endpoints" \
  -H "Authorization: Bearer $XR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "billing-sync",
  "url": "https://hooks.acme.example/xradius",
  "events": ["user.created", "user.disconnected"],
  "all_events": false,
  "enabled": true
}'

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us