WIwithpersona
webhooks

Create a Webhook

Changed on

Creates a new webhook with response defaults.

post/webhooks

Request

  • Base URL
    https://api.withpersona.com/api/v1
  • URL
    https://api.withpersona.com/api/v1/webhooks
  • Auth
    HTTP bearer

Query parameters

includestring

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsobject

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Request body

Response

This endpoint returns a Webhook object.

Changes

  • d1a8abd5d271Revision changes
    • info

      added the new authentication-template.authentication-errored enum value to the request property ////

  • 5b288706d170Revision changes
    • info

      added the new deployment.completed enum value to the request property ////