Graphon API

Create a webhook

Registers an HTTPS receiver for the events of the workspace, optionally only some event types and buckets. Any member can make a personal webhook. A workspace key makes a workspace webhook. The signing secret appears once.

POST/v1/workspaces/{workspaceId}/webhooks

Authentication

Send your Graphon API key with every request. The value is the whole API key that Graphon showed when you created it. See Authentication.

Authorization: Bearer <GRAPHON_API_KEY>

Path parameters

The workspace id.

Request body

namestring

Display name, 1 to 100 characters.

urlstring

The receiver. HTTPS, no user name or password, no fragment, and a public address.

eventTypesstring[] (optional)

Event types to send. Leave out or send null for every type.

bucketIdsstring[] (optional)

Buckets whose events to send. Leave out or send null for every bucket.

enabledboolean (optional)

Default true.

ownerstring (optional)

Defaults to me for a member and to workspace for a workspace key. Only an Admin can make a workspace webhook as a member. One of: me, workspace.

Was this page helpful?
View as Markdown