Docs
API reference

Webhooks

Download spec

List webhooks

GET
/webhooks

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from Settings → Developers → API keys.

Response Body

Success. Writes without read permission return an ID and revision only.

application/json
  1. response
webhooks*array<>
Example Request
curl -X GET 'https://app.italic.com/api/v2/webhooks'
Example Response
{
  "webhooks": [
    {
      "id": "string",
      "url": "string",
      "events": [
        "string"
      ],
      "createdAt": 0
    }
  ]
}

Create a webhook

POST
/webhooks

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from Settings → Developers → API keys.

Header Parameters

Idempotency-Key?string

Reuse the same key and body when retrying; the retry returns the first result with replayed: true. Keys are kept for 24 hours.

Length1 <= length <= 128

Request Body

application/json
  1. body
url*string
Length1 <= length <= 2048
events*array<>
Items1 <= items <= 3

Response Body

Success. Writes without read permission return an ID and revision only.

application/json
  1. response
webhook*
secret*string
replayed?boolean
Example Request
curl -X POST 'https://app.italic.com/api/v2/webhooks' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "string",
  "events": [
    "recording.created"
  ]
}'
Example Response
{
  "webhook": {
    "id": "string",
    "url": "string",
    "events": [
      "string"
    ],
    "createdAt": 0
  },
  "secret": "string",
  "replayed": true
}

Delete a webhook

DELETE
/webhooks/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from Settings → Developers → API keys.

Path Parameters

id*string
Match^[A-Za-z0-9][A-Za-z0-9._:-]*$
Length1 <= length <= 256

Response Body

Success. Writes without read permission return an ID and revision only.

application/json
  1. response
id*string
Match^[A-Za-z0-9][A-Za-z0-9._:-]*$
Length1 <= length <= 256
deleted*boolean
Example Request
curl -X DELETE 'https://app.italic.com/api/v2/webhooks/string'
Example Response
{
  "id": "string",
  "deleted": true
}