---
title: "Create a webhook"
method: POST
path: "/webhooks"
---

# Create a webhook

`POST /webhooks`

## Request

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

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

## Request body

- CreateWebhookRequest
  - `url` string, uri, required
  - `events` string[]: 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 `201`

Webhook created

- object
  - `webhook` Webhook
    - `id` string
    - `url` string, uri
    - `events` string[]
    - `active` boolean
    - `secret` string
    - `createdAt` string, date-time

## Other responses

- `401`: API key is missing or wrong
- `403`: Your key doesn't have the scope this needs

---

[API](https://skmtc.dev/osis/apis/comms-api.md) · [All operations](https://skmtc.dev/osis/apis/comms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/osis/apis/comms-api/revisions/59a4c0ba8936?raw)