Test a webhook

curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/webhooks/{id}/test \
  --header 'Authorization: <api-key>'

Webhooks

Test a webhook

Sends a test event to the webhook

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses write_database

OAuth Scopes

Resource	Scopes
Organization	`write_databases`
Database	`write_database`

POST

organizations

{organization}

databases

{database}

webhooks

{id}

test

Test a webhook

curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/webhooks/{id}/test \
  --header 'Authorization: <api-key>'

Authorizations

Authorization

string

header

required

Path Parameters

organization

string

required

The name of the organization

database

string

required

The name of the database

string

required

The ID of the webhook

Response

Webhook test event successfully triggered

Delete a webhook

Get invoices

Introduction

Webhooks in PlanetScale

Authentication

PlanetScale API

Test a webhook

Authorization

Authorizations

Path Parameters

Response