Webhooks

Register Or Update Webhook

Creates or replaces a webhook registration for the current tenant and application owner. A registration must contain either app events or ops events, but not both. Ops event registrations require ReadDevOps scope.

Use http://webhook.site (or equivalent) as a temporary receiver when validating payload shape and delivery.

put/api/v1/webhooks

Request

  • Base URL: /sandbox (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /sandbox/api/v1/webhooks
  • Auth: none declared

Request body

idstring nullable

e.g. webhook_c0645dc026a74ae99ec436df63d77d2c

enabledboolean

Is this webhook active

urlstring nullable

Receiver endpoint of this webhook, specific to this tenant this webhook belongs to

secretstring uuid

Secret used to sign payload, so the receiver can validate it in X-PE2-WEBHOOK-SIGNATURE header, using SHA256 algorithm on the JSON payload

eventsstring[] nullable

Events of interest: MatterCreated, MatterUpdated, MatterDeleted

Response

OK

successboolean
reasonstring nullable
resultCode0 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110

Represents the outcome of a command execution. Used to indicate success or the reason for failure when a command does not succeed.

sourceIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.