Skip to main content
POST
/
organizations
/
{organization}
/
databases
/
{database}
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "enabled": true,
  "events": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "enabled": true,
  "last_sent_result": "<string>",
  "last_sent_success": true,
  "last_sent_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "events": [
    "branch.ready"
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization
string
required

The name of the organization

​
database
string
required

The name of the database

Body

application/json
​
url
string
required

The URL the webhook will send events to

​
enabled
boolean

Whether the webhook should be enabled

​
events
string[]

The events this webhook should subscribe to

Response

Returns the created webhook

​
id
string
required

The ID of the webhook

​
url
string
required

The URL the webhook will send events to

​
secret
string
required

The secret used to sign the webhook payloads

​
enabled
boolean
required

Whether the webhook is enabled

​
last_sent_result
string
required

The last result sent by the webhook

​
last_sent_success
boolean
required

Whether the last sent was successful

​
last_sent_at
string
required

When the last event was sent

​
created_at
string
required

When the webhook was created

​
updated_at
string
required

When the webhook was updated

​
events
enum<string>[]
required

The events this webhook subscribes to

Available options:
branch.ready,
branch.anomaly,
branch.primary_promoted,
branch.schema_recommendation,
branch.sleeping,
branch.start_maintenance,
cluster.storage,
database.access_request,
deploy_request.closed,
deploy_request.errored,
deploy_request.in_progress,
deploy_request.opened,
deploy_request.pending_cutover,
deploy_request.queued,
deploy_request.reverted,
deploy_request.schema_applied,
keyspace.storage,
webhook.test