Ricky logorickyDocs

Send a test event

POST
/webhooks/{webhook_id}/test

Sends one signed webhook.test event to the endpoint now and answers what it replied. It is not recorded as a delivery and is not retried.

Scope: webhooks:manage.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

webhook_id*string

Webhook ID.

Formatuuid

Response Body

Success.

application/json
  1. response
data*

What the endpoint answered to a webhook.test event.

curl -X POST 'https://getricky.ai/api/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/test'
{  "data": {    "delivered": true,    "response_status": 200,    "error": null,    "duration_ms": 184  }}

Disable a webhook DELETE

Stops new and pending deliveries. Disabling twice answers `404`. Scope: `webhooks:manage`.

Rotate the signing secret POST

Returns a new `signing_secret`, the only time Ricky shows it. Until `expire_previous_after_hours` passes, every delivery carries two signatures in `X-Ricky-Signature`, new first, so you can deploy the new secret without missing events. The body is optional. Scope: `webhooks:manage`.