Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.plain.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Using TypeScript? Check out our GraphQL SDK for a fully typed client.
A webhook target is an HTTP endpoint that Plain delivers events to. Each target subscribes to one or more event types and is pinned to a specific webhook schema version. This section of the GraphQL API covers the management of webhook targets — how to register a new endpoint, change which events it receives, disable it temporarily, or inspect delivery attempts when something goes wrong. If you’re looking for the format of the events themselves, see Webhooks. The mutations below all require the following permissions:
  • webhookTarget:create
  • webhookTarget:edit
  • webhookTarget:delete
The read queries require:
  • webhookTarget:read
Webhook targets can also be created and managed in the Plain app under Settings → Webhooks. Use the API when you want to provision targets as part of an infrastructure-as-code setup or to wire up environments programmatically.