Create a webhook

POST/v1/workspaces/{workspaceId}/webhooks

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.

View as Markdown

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>

curl \
  --url "https://api.beta.graphon.ai/v1/workspaces/wspq7ws2np5l8z4/webhooks" \
  --header "Authorization: Bearer $GRAPHON_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"indexing-callbacks","url":"https://hooks.example.com/graphon","eventTypes":["object.indexed","object.indexing_failed"]}'

Request

Loading your session…

Response

JSON

{
  "webhook": {
    "id": "whkN4vB7qX2mZ",
    "workspaceId": "wspq7ws2np5l8z4",
    "name": "indexing-callbacks",
    "url": "https://hooks.example.com/graphon",
    "eventTypes": [
      "object.indexed",
      "object.indexing_failed"
    ],
    "bucketIds": null,
    "enabled": true,
    "disabledReason": null,
    "ownerKind": "user",
    "ownerUserId": "usrB2c3D4e5F6",
    "signing": {
      "secretFingerprint": "sha256:9b2d44f0",
      "previousSecretFingerprint": null,
      "previousSecretExpiresAt": null
    },
    "delivery": {
      "pendingDeliveries": 0,
      "lastSucceededAt": "2026-10-14T09:05:13.004Z",
      "lastFailedAt": null
    },
    "createdBy": {
      "userId": "usrB2c3D4e5F6",
      "apiKeyId": null
    },
    "createdAt": "2026-10-14T09:00:00.000Z",
    "updatedAt": "2026-10-14T09:00:00.000Z"
  },
  "secret": "whsec_<shown once>"
}

Path parameters

workspaceIdstring

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?