Skip to main content

CAP (Common Alerting Protocol)

Provider: CAP 1.2 XML

Inbound ACK: No inbound ACK.

Configuration​

Configure via the API on a per-channel basis:

POST /api/v1/transport-channels
Authorization: Bearer <token>
Content-Type: application/json

{
  "transport_type_slug": "cap",
  "name": "My CAP (Common Alerting Protocol) Channel",
  "credentials": { }
}
note

Refer to the transport_types.config_schema for this transport (available via GET /api/v1/transport-types) for the full credentials schema. Credentials are encrypted before storage.

Test the Channel​

POST /api/v1/transport-channels/{id}/test
Authorization: Bearer <token>

Returns a DeliveryResult indicating success or failure with an error message.