setup-webhook

Create & Manage Webhooks

Webhooks allow users to receive HTTP POST notifications when events occur, such as SMS delivery status changes, inbound messages, link clicks, and opt-outs.

Authentication

• Header: x-api-key: {KUDOSITY_API_KEY}
• If the user hasn't configured credentials, direct them to run /setup

API Details

• Base URL: https://api.transmitmessage.com
• Content-Type: application/json
• All requests use curl commands

Create a Webhook

Endpoint: POST /v2/webhook

Required parameters:

• name (string): Webhook name, 2-100 characters
• url (string): HTTPS URL that accepts JSON-encoded POST requests

Optional parameters:

• filter (object): Filter which events trigger the webhook
  • event_type (array): Types of events to subscribe to
  • sender (array): Filter by sender number
  • status (array): Filter by message status (for status events only)
  • message_ref (array): Filter by message reference
  • campaign_id (array): Filter by campaign ID
• rate_limit (integer): Max requests per second to your URL (max 10,000, 0 = system default)

Available Event Types

Event Type	Description
SMS_STATUS	SMS delivery status changes (SENT, ACCEPTED, DELIVERED, FAILED, SOFT_BOUNCE, HARD_BOUNCE, OTHER)
SMS_INBOUND	Inbound SMS received from a recipient
MMS_STATUS	MMS status changes (SENT, FAILED)
MMS_INBOUND	Inbound MMS received from a recipient
LINK_HIT	Recipient clicked a tracked link
OPT_OUT	Recipient opted out via link or STOP message

Filter Logic

• Within a filter array (e.g., multiple senders): conditions are combined with OR
• Between different filters (e.g., sender AND status): conditions are combined with AND

Example: Create a webhook for SMS delivery status and inbound messages

curl -s -X POST "https://api.transmitmessage.com/v2/webhook" \
  -H "x-api-key: ${KUDOSITY_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "SMS Events",
    "url": "https://myapp.com/webhooks/sms",
    "filter": {"event_type": ["SMS_STATUS", "SMS_INBOUND"]}
  }'