Skip to main content
POST
Register a webhook endpoint
Minimum role required: Admin

Authorizations

X-Axilio-Api-Key
string
header
required

Customer API key (axl_ prefix).

Body

application/json

Request body for registering an outbound webhook or BYOS endpoint.

config
object

Non-secret configuration for a BYOS destination (e.g. queue_url + region for aws_sqs).

credentials
object

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
string[] | null

Event types to subscribe to. Empty means all event types.

Maximum array length: 100
type
enum<string>

Destination type: webhook (default when omitted), aws_sqs, aws_s3, or aws_kinesis.

Available options:
webhook,
aws_sqs,
aws_s3,
aws_kinesis
url
string<uri>

HTTPS endpoint that signed events are delivered to (webhook destinations).

Maximum string length: 2048

Response

Created

A newly registered webhook endpoint, including its signing secret (shown once).

created_at
string<date-time>
required

Timestamp when the endpoint was registered.

event_types
string[] | null
required

Subscribed event types ("*" means all).

id
string
required

Endpoint identifier.

type
enum<string>
required

Destination type: webhook or a BYOS type (aws_sqs, aws_s3, aws_kinesis).

Available options:
webhook,
aws_sqs,
aws_s3,
aws_kinesis
config
object

Non-secret configuration of a BYOS destination (e.g. queue_url + region). Absent for webhook destinations.

secret
string

Standard Webhooks signing secret (whsec_...), webhook destinations only. Shown once at creation and never returned again. Absent for BYOS destinations.

url
string

Delivery endpoint URL (webhook destinations).