Axiym

Register and manage subscriptions

View Markdown

To receive PNSL events, register an HTTPS endpoint.

Endpoint requirements

  • HTTPS only.
  • Publicly reachable by Axiym.
  • Verifies deliveries and durably stores accepted events before returning 2XX. Verified duplicates already stored can also be acknowledged.

Create a subscription

  • Endpoint: POST /webhooks/subscriptions
  • Payload: endpoint, the full HTTPS URL of your receiver.
  • Response: a Subscription with its subscriptionId.
{
  "endpoint": "https://api.example.com/webhooks"
}

Test, list, disable

  • Test: POST /webhooks/subscriptions/{subscriptionId}/tests sends a subscription.test event with data { "test": "OK" }.
  • List: GET /webhooks/subscriptions.
  • Disable: DELETE /webhooks/subscriptions/{subscriptionId} stops deliveries to that endpoint.

Verify every delivery before processing it; see Verify signatures.