Create a webhook

Add an HTTPS URL where Comms will send events. Scope: comms_webhooks.

post/webhooks

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
eventsstring[]

The events you want, like comms.message.received, comms.message.edited, comms.message.sent, or comms.message.read. For one-to-one iMessage and RCS, comms.message.read fires when the recipient's phone sends a read receipt (read receipts must be on); never for SMS. No receipt does not mean unread. Leave it out to get every event that exists when you create the webhook.

Response

Webhook created

Changes

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