Register a webhook | Aura Panic API

Registers a webhook so AURA posts event payloads to your URL as callouts, subscriptions, and customers change. Provide the events to subscribe to and any custom headers to include on each delivery. The URL must be HTTPS, and each customer source has a single active webhook — registering replaces it. The API path retains notifiers; docs use webhook terminology.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

HTTPS endpoint AURA posts event payloads to.

eventslist of stringsRequired

Event types to subscribe to, for example NEW_CALLOUT, CALLOUT_CLOSED.

methodstringOptionalDefaults to webhook

Delivery method. Use webhook.

headersmap from strings to stringsOptional

Custom headers included on every delivery, for example an authorization token.

Response

Webhook registered.

messagestring

notifierobject

Errors

400

Bad Request Error

401

Unauthorized Error

$	curl -X POST https://staging-panic.aura.services/panic-api/v2/notifiers/webhooks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"url": "https://your-server.example.com/api/webhooks/events",
>	"events": [
>	"NEW_CALLOUT",
>	"CALLOUT_CLOSED"
>	],
>	"method": "webhook",
>	"headers": {
>	"authorization": "Bearer <your-token>"
>	}
>	}'

1	{
2	"message": "string",
3	"notifier": {
4	"config": [
5	{
6	"url": "string",
7	"events": [
8	"string"
9	],
10	"method": "string",
11	"headers": {}
12	}
13	]
14	}
15	}

$	curl -X POST https://staging-panic.aura.services/panic-api/v2/notifiers/webhooks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"url": "https://your-server.example.com/api/webhooks/events",
>	"events": [
>	"NEW_CALLOUT",
>	"CALLOUT_CLOSED"
>	],
>	"method": "webhook",
>	"headers": {
>	"authorization": "Bearer <your-token>"
>	}
>	}'

1	{
2	"message": "string",
3	"notifier": {
4	"config": [
5	{
6	"url": "string",
7	"events": [
8	"string"
9	],
10	"method": "string",
11	"headers": {}
12	}
13	]
14	}
15	}