Osis Co Webhooks

generated: '2026-10-31'
method: searched
generator: extract-docs-artifacts.py (local)
source: https://docs.osis.co/guides/webhooks.md
sources:
- https://docs.osis.co/guides/webhooks.md
- https://docs.osis.co/messages-api/list-webhooks.md
- https://docs.osis.co/messages-api/create-webhook.md
- https://docs.osis.co/messages-api/list-events.md
description: Osis Comms webhooks deliver a variety of messaging, call, payment, and contact events.
events:
- event: comms.message.received
  description: Someone sent you a message
- event: comms.message.submitted
  description: Comms accepted your message and is sending it
- event: comms.message.sent
  description: Your message went out
- event: comms.message.delivered
  description: The message was delivered
- event: comms.message.read
  description: The recipient read your message
- event: comms.message.failed
  description: Your message failed to send
- event: comms.message.suppressed
  description: Your message was stopped before sending
- event: comms.message.unknown
  description: Comms can't yet tell whether your message went out
- event: comms.message.edited
  description: Someone edited an iMessage they sent you
- event: comms.message.reaction.added
  description: Someone added a reaction
- event: comms.message.reaction.removed
  description: Someone removed a reaction
- event: comms.poll.voted
  description: Someone voted on an iMessage poll
- event: comms.location.updated
  description: A contact shared or updated their location with your dedicated number
- event: comms.location.stopped
  description: A contact stopped sharing or their share expired
- event: comms.contact.opted_out
  description: A contact opted out of messages
- event: comms.contact.opted_in
  description: A contact opted back in
- event: comms.call.incoming
  description: A call is ringing on one of your lines
- event: comms.call.answered
  description: A call was answered
- event: comms.call.transcript
  description: A transcript turn is ready
- event: comms.call.ended
  description: A call ended
- event: comms.call.failed
  description: A call failed to connect or dropped
- event: comms.call.voicemail
  description: A caller left a voicemail
- event: comms.payment.paid
  description: A payment was confirmed
- event: comms.payment.canceled
  description: The merchant canceled a Shopify order from a Comms checkout
- event: comms.payment.refunded
  description: The merchant refunded some or all of a Comms checkout payment
- event: comms.line.number_changed
  description: A dedicated number replacement finished
- event: comms.ping
  description: A test event you sent
delivery:
  signature: HMAC-SHA256 of the raw request body using the webhook secret
  content_type: application/json; charset=utf-8 (raw body is signed, not the JSON stringified version only) – see docs for exact usage
note: Every request includes an X-Osis-Event header and an X-Osis-Signature header (format sha256=<hex>). The secret returned on creation starts
  with whsec_.
docs: https://docs.osis.co/guides/webhooks.md