Ricky logorickyDocs

Create a webhook

POST
/webhooks

The response carries signing_secret, the only time Ricky shows it.

Scope: webhooks:manage.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Request Body

application/json
  1. body
url*string

Public HTTPS endpoint.

Formaturi
Lengthlength <= 2048
event_types*array<>
Items1 <= items <= 5

Response Body

Success.

application/json
  1. response
data*

A new webhook subscription with its signing secret.

curl -X POST 'https://getricky.ai/api/v1/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "url": "https://example.com/ricky/webhooks",  "event_types": [    "message.received",    "conversation.closed"  ]}'
{  "data": {    "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",    "url": "https://example.com/ricky/webhooks",    "event_types": [      "message.received"    ],    "status": "active",    "created_at": "2026-10-14T15:30:00.000Z",    "disabled_at": "2026-10-14T15:30:00.000Z",    "signing_secret": "whsec_7Yb2kQ9…"  }}