CapyDB
Start free
CapyDB/ docs
ReferenceAPI

Webhooks

Outbound webhook endpoints and delivery history.

All docs

List webhook endpoints

GET
/v1/organizations/{orgID}/webhook-endpoints

Authorization

headerAuthorizationBearer <token>

Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.

Path Parameters

orgID*string

Organization id.

Response Body

Webhook endpoints with computed delivery health.

application/json
  1. response
webhook_endpoints*array<>
curl -X GET 'https://capydb.dev/api/capydb/v1/organizations/string/webhook-endpoints'
{  "webhook_endpoints": [    {      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "event_types": [        "job.completed"      ],      "id": "string",      "is_active": true,      "organization_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "url": "http://example.com",      "health": "healthy"    }  ]}

Create a webhook endpoint

POST
/v1/organizations/{orgID}/webhook-endpoints

Authorization

headerAuthorizationBearer <token>

Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.

Path Parameters

orgID*string

Organization id.

Request Body

application/json
  1. body
description?string
event_types?array<>

Event types to deliver (see x-webhook-events). Empty subscribes to all events.

url*string

HTTPS receiver URL.

Formaturi

Response Body

Webhook endpoint created.

application/json
  1. response
webhook_endpoint*
plaintext_secret*string

The endpoint's signing secret. Shown exactly once.

curl -X POST 'https://capydb.dev/api/capydb/v1/organizations/string/webhook-endpoints' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com"}'
{  "webhook_endpoint": {    "created_at": "2019-08-24T14:15:22Z",    "description": "string",    "event_types": [      "job.completed"    ],    "id": "string",    "is_active": true,    "organization_id": "string",    "updated_at": "2019-08-24T14:15:22Z",    "url": "http://example.com"  },  "plaintext_secret": "string"}

Update a webhook endpoint

PATCH
/v1/organizations/{orgID}/webhook-endpoints/{endpointID}

Authorization

headerAuthorizationBearer <token>

Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.

Path Parameters

orgID*string

Organization id.

endpointID*string

Webhook endpoint id.

Request Body

application/json
  1. body
description?string|null
event_types?array<>|null
is_active?boolean|null
url?|
Formaturi

Response Body

Updated webhook endpoint.

application/json
  1. response
webhook_endpoint*
curl -X PATCH 'https://capydb.dev/api/capydb/v1/organizations/string/webhook-endpoints/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "webhook_endpoint": {    "created_at": "2019-08-24T14:15:22Z",    "description": "string",    "event_types": [      "job.completed"    ],    "id": "string",    "is_active": true,    "organization_id": "string",    "updated_at": "2019-08-24T14:15:22Z",    "url": "http://example.com"  }}

Delete a webhook endpoint

DELETE
/v1/organizations/{orgID}/webhook-endpoints/{endpointID}

Authorization

headerAuthorizationBearer <token>

Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.

Path Parameters

orgID*string

Organization id.

endpointID*string

Webhook endpoint id.

Response Body

Endpoint deleted.

application/json
  1. response
deleted*boolean
curl -X DELETE 'https://capydb.dev/api/capydb/v1/organizations/string/webhook-endpoints/string'
{  "deleted": true}

Rotate a webhook endpoint's signing secret

POST
/v1/organizations/{orgID}/webhook-endpoints/{endpointID}/rotate-secret

Authorization

headerAuthorizationBearer <token>

Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.

Path Parameters

orgID*string

Organization id.

endpointID*string

Webhook endpoint id.

Response Body

Secret rotated.

application/json
  1. response
webhook_endpoint*
plaintext_secret*string

The new signing secret. Shown exactly once.

curl -X POST 'https://capydb.dev/api/capydb/v1/organizations/string/webhook-endpoints/string/rotate-secret'
{  "webhook_endpoint": {    "created_at": "2019-08-24T14:15:22Z",    "description": "string",    "event_types": [      "job.completed"    ],    "id": "string",    "is_active": true,    "organization_id": "string",    "updated_at": "2019-08-24T14:15:22Z",    "url": "http://example.com"  },  "plaintext_secret": "string"}

List webhook deliveries

GET
/v1/organizations/{orgID}/webhook-endpoints/{endpointID}/deliveries

Authorization

headerAuthorizationBearer <token>

Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.

Path Parameters

orgID*string

Organization id.

endpointID*string

Webhook endpoint id.

Query Parameters

limit?integer

Maximum number of deliveries to return (default 50).

Range0 <= value
Default50

Response Body

Delivery history.

application/json
  1. response
deliveries*array<>
curl -X GET 'https://capydb.dev/api/capydb/v1/organizations/string/webhook-endpoints/string/deliveries'
{  "deliveries": [    {      "attempts": 0,      "created_at": "2019-08-24T14:15:22Z",      "delivered_at": "2019-08-24T14:15:22Z",      "endpoint_id": "string",      "event_type": "string",      "id": "string",      "last_error": "string",      "max_attempts": 0,      "next_attempt_at": "2019-08-24T14:15:22Z",      "organization_id": "string",      "payload": null,      "response_status": 0,      "state": "pending",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Redeliver a webhook delivery

POST
/v1/organizations/{orgID}/webhook-endpoints/{endpointID}/deliveries/{deliveryID}/redeliver

Authorization

headerAuthorizationBearer <token>

Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.

Path Parameters

orgID*string

Organization id.

endpointID*string

Webhook endpoint id.

deliveryID*string

Delivery ID to redeliver.

Response Body

Redelivery enqueued.

application/json
  1. response
delivery*
curl -X POST 'https://capydb.dev/api/capydb/v1/organizations/string/webhook-endpoints/string/deliveries/string/redeliver'
{  "delivery": {    "attempts": 0,    "created_at": "2019-08-24T14:15:22Z",    "delivered_at": "2019-08-24T14:15:22Z",    "endpoint_id": "string",    "event_type": "string",    "id": "string",    "last_error": "string",    "max_attempts": 0,    "next_attempt_at": "2019-08-24T14:15:22Z",    "organization_id": "string",    "payload": null,    "response_status": 0,    "state": "pending",    "updated_at": "2019-08-24T14:15:22Z"  }}

Send a test webhook event

POST
/v1/organizations/{orgID}/webhook-endpoints/{endpointID}/test

Authorization

headerAuthorizationBearer <token>

Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.

Path Parameters

orgID*string

Organization id.

endpointID*string

Webhook endpoint id.

Response Body

Test delivery enqueued.

application/json
  1. response
delivery*
curl -X POST 'https://capydb.dev/api/capydb/v1/organizations/string/webhook-endpoints/string/test'
{  "delivery": {    "attempts": 0,    "created_at": "2019-08-24T14:15:22Z",    "delivered_at": "2019-08-24T14:15:22Z",    "endpoint_id": "string",    "event_type": "string",    "id": "string",    "last_error": "string",    "max_attempts": 0,    "next_attempt_at": "2019-08-24T14:15:22Z",    "organization_id": "string",    "payload": null,    "response_status": 0,    "state": "pending",    "updated_at": "2019-08-24T14:15:22Z"  }}

Jobs

Asynchronous job tracking.

A P I Keys

Org and project-scoped API key management.