Register a webhook endpoint
Registers an HTTPS endpoint to receive signed events for the caller’s organization, subscribed to a set of event types (or all). The signing secret is returned exactly once.
Authorizations
Customer API key (axl_ prefix).
Body
Request body for registering an outbound webhook or BYOS endpoint.
Non-secret configuration for a BYOS destination (e.g. queue_url + region for aws_sqs).
Customer secrets for a BYOS destination (e.g. AWS key/secret). Never stored or logged by Axilio; passed to the delivery gateway, which encrypts them.
Event types to subscribe to. Empty means all event types.
100Destination type: webhook (default when omitted), aws_sqs, aws_s3, or aws_kinesis.
webhook, aws_sqs, aws_s3, aws_kinesis HTTPS endpoint that signed events are delivered to (webhook destinations).
2048Response
Created
A newly registered webhook endpoint, including its signing secret (shown once).
Timestamp when the endpoint was registered.
Subscribed event types ("*" means all).
Endpoint identifier.
Destination type: webhook or a BYOS type (aws_sqs, aws_s3, aws_kinesis).
webhook, aws_sqs, aws_s3, aws_kinesis Non-secret configuration of a BYOS destination (e.g. queue_url + region). Absent for webhook destinations.
Standard Webhooks signing secret (whsec_...), webhook destinations only. Shown once at creation and never returned again. Absent for BYOS destinations.
Delivery endpoint URL (webhook destinations).