Skip to main content
POST
Create Webhook
Register a new webhook endpoint to receive real-time event notifications via HTTP POST.

Request Body

string
required
The HTTPS URL that will receive webhook events.
string[]
required
List of event types to subscribe to. See Webhooks for available event types.
string
required
Signing secret used to verify webhook payloads. Must start with whsec_.

Example

Response

Authorizations

X-API-Key
string
header
required

API key authentication. Keys are prefixed with awx_.

Body

application/json
url
string<uri>
required

The HTTPS URL that will receive webhook events.

events
string[]
required

List of event types to subscribe to (e.g., payment.completed, payment.failed, policy.violated).

secret
string
required

Signing secret used to verify webhook payloads. Must start with whsec_.

Response

Webhook created successfully.

A registered webhook endpoint for receiving real-time event notifications.

id
string

Unique webhook identifier (e.g., whk_abc123).

url
string<uri>

HTTPS URL that receives webhook events.

events
string[]

List of subscribed event types.

status
enum<string>

Webhook status.

Available options:
active,
inactive
created_at
string<date-time>

ISO 8601 creation timestamp.