Webhooks

Create a webhook endpoint

Creates an endpoint. The response is the only time the signing secret is returned in full; store it immediately.

post/webhook-endpoints

Request

  • Base URL: https://api.palisade.email
  • URL: https://api.palisade.email/webhook-endpoints
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Headers

Palisade-Version'2025-04-30' | 'unstable' required

Request body

urlstring uri required
descriptionstring
enabled_eventsstring[]

Event types this endpoint receives. Omit it, or send an empty array, to receive every event including ones added later.

Response

Created

idstring uuid required
urlstring uri required
descriptionstring nullable required
enabled_eventsstring[] required

Event types this endpoint receives. An empty array means every event, including ones added later — not none.

status'ENABLED' | 'DISABLED' | 'AUTO_DISABLED' required

ENABLED receives events. DISABLED was turned off by you. AUTO_DISABLED was turned off by Palisade after repeated delivery failures and stays off until you re-enable it, which also clears the failure count.

secret_reminderstring required

Last 4 characters of the signing secret. The full secret is returned only at creation.

api_versionstring required

API version the payload shape is pinned to, captured when the endpoint was created.

consecutive_failuresnumber required
disabled_reasonstring nullable required
last_success_atstring date-time nullable required
last_failure_atstring date-time nullable required
created_bystring required
created_atstring date-time required
updated_atstring date-time required
secretstring required

The signing secret, shown once. Store it now; it cannot be retrieved later.

Changes

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