AXaxilioai
webhooks

Register a webhook endpoint

Changed on

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.

post/webhooks/endpoints

Request

Request body

$schemastring uri

A URL to the JSON Schema for this object.

configobject

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

credentialsobject

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_typesstring[] nullable

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

type'webhook' | 'aws_sqs' | 'aws_s3' | 'aws_kinesis'

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

urlstring uri

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

Example request

{
  "$schema": "/api/v1/WebhookEndpointCreateRequest.json"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

configobject

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

created_atstring date-time required

Timestamp when the endpoint was registered.

event_typesstring[] nullable required

Subscribed event types ("*" means all).

idstring required

Endpoint identifier.

secretstring

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

type'webhook' | 'aws_sqs' | 'aws_s3' | 'aws_kinesis' required

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

urlstring

Delivery endpoint URL (webhook destinations).

Example response

{
  "$schema": "/api/v1/WebhookEndpointCreateResponse.json"
}

Changes