Create, test or delete a webhook
everypage_manage_webhookCreate, test, and delete EveryPage webhook endpoints to receive signed event notifications when documents are opened, viewed, downloaded, or leads are captured; creation returns a signing secret.
Instructions
Manage where EveryPage sends event notifications. Create an endpoint to receive signed deliveries when a document is opened, read, downloaded or a lead is captured; send a test delivery to check an endpoint is reachable; or delete one. Creating returns a signing secret that is shown only once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | create: the https:// endpoint that will receive deliveries. | |
| file | No | create: limit deliveries to one document. Omit for the whole account. | |
| action | Yes | What to do. | |
| events | No | create: which events to deliver. file.opened fires the moment a reader opens a document; file.viewed fires when their reading session ends and carries pages viewed and time spent. gate.completed (captured leads) requires the Pro plan at the time the event happens. | |
| format | No | create: json (signed, for your own code) or slack (Slack Block Kit for an incoming webhook). Default json. | |
| webhook | No | test/delete: the endpoint's id, from everypage_list_webhooks. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | ||
| secret | No | Shown exactly once, at creation. Store it now. | |
| status | No | ||
| deleted | No | ||
| webhook | No | ||
| delivered | No | ||
| latencyMs | No |