otp-webhooks-v2

Register a new webhook endpoint

post/v2/otp/webhooks

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/otp/webhooks
  • Auth: API key in header X-Api-Key

Request body

eventsstring[]

Event types to subscribe to (defaults to all)

urlstring required

HTTPS URL to receive webhook events

Response

Webhook created

autoPausedboolean

Whether auto-paused due to failures

consecutiveFailuresinteger

Current consecutive failure streak

createdAtstring

ISO 8601 creation timestamp

eventsstring[]

Subscribed event types

failureCountinteger

Total delivery failures

hasSecretboolean

Whether a signing secret is configured

idstring

Webhook endpoint ID

statusstring

active, paused, or failed

urlstring

Registered URL

secretstring

HMAC signing secret (shown only on creation)

Changes

No recorded changes to this operation across all 1 revision of this API.