COcontext
webdbs

Create a webhook

Changed on

Creates a webhook for row and run events. Use the returned secret to verify signatures.

post/webdbs/webhooks

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/webdbs/webhooks
  • Auth
    HTTP bearer

Request body

urlstring uri required

HTTPS URL that receives events.

eventsstring[] required

Events sent to this webhook.

collection_idstring

Collection to watch. Omit to watch all collections.

delivery'instant' | 'batch'

Send events immediately or in batches.

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Example request

{
  "tags": [
    "production",
    "team-alpha"
  ]
}

Response

Webhook created

idstring required

Webhook ID.

urlstring uri required

HTTPS URL that receives events.

eventsstring[] required

Events sent to this webhook.

collection_idstring nullable required

Collection being watched, or null for all collections.

delivery'instant' | 'batch' required

Whether events are sent immediately or in batches.

secretstring required

Secret used to verify webhook signatures.

status'active' | 'disabled' required

Current webhook status.

created_atstring date-time required

Time the webhook was created.

updated_atstring date-time required

Time the webhook was last updated.

Example response

{
  "id": "wh_123"
}

Changes

  • 182f532c2552Revision changes
    • warning

      added the new WEBSITE_BLOCKED enum value to the response property for the response status

    • warning

      added the new WEBSITE_BLOCKED enum value to the response property for the response status

  • 3c6a01ba967fRevision changes
    • warning

      added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the response property for the response status

    • warning

      added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the response property for the response status