Webhooks - Comms

Webhooks push events to your server when something happens on the line — for example a message is received or sent. Use them when you want real-time updates instead of polling GET /messages.

Prerequisites

A Messages API key with the comms_webhooks scope.
A public HTTPS URL that accepts POST.

Register an endpoint

curl -X POST "https://osis.co/api/v1/comms/webhooks" \
  -H "Authorization: Bearer $COMMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://hooks.yourapp.com/comms",
    "events": ["message.received", "message.sent"]
  }'

Scope: comms_webhooks
Success: 201 with the created webhook object.

List endpoints

curl "https://osis.co/api/v1/comms/webhooks" \
  -H "Authorization: Bearer $COMMS_API_KEY"

Local development

Run your app with a POST handler that logs the body.
Tunnel with ngrok / Cloudflare Tunnel.
Register the tunnel URL as above.
Send a test message to your line (or fire a test from the API if available on your deployment).

Handler checklist

Respond quickly

Return 2xx as soon as you accept the event. Do heavy work in a queue.

Treat delivery as at-least-once

The same event may arrive more than once. Make handlers idempotent on event id when present.

Keep secrets off the client

Webhook receivers belong on your server. Do not process hooks in a browser.

Create webhook
List webhooks
List events — poll delivery attempts if you need pull-based debugging

Idempotency Errors & rate limits

​Prerequisites

​Register an endpoint

​List endpoints

​Local development

​Handler checklist

​Related

Prerequisites

Register an endpoint

List endpoints

Local development

Handler checklist

Related