Sign in
Webhooks V2

Create Webhook Endpoint

Creates a new webhook endpoint for the project. Requires webhooks:write scope.

post/v2/projects/{project_id}/webhook_endpoints

Path parameters

project_idstring required

Project ID

Project ID

Query parameters

format'superwall' | 'superwall_v2'

Which webhook delivery application this endpoint belongs to. superwall_v2 receives typed Superwall V2 payloads. Defaults to superwall.

Which webhook delivery application this endpoint belongs to. superwall_v2 receives typed Superwall V2 payloads. Defaults to superwall.

Request body

urlstring required

The URL where webhook events will be sent

descriptionstring

Description of the webhook endpoint

filter_typesstring[]

List of event types to filter. If omitted, all events are sent

headersobject

Custom headers to include with webhook requests

metadataobject

Arbitrary key-value metadata

Response

Success

idstring required

Unique identifier for the webhook endpoint

object'webhook_endpoint' required

Object type, always webhook_endpoint

urlstring required

The URL where webhook events are sent

descriptionstring nullable required

Description of the webhook endpoint

versionnumber required

Webhook endpoint version

disabledboolean required

Whether the webhook endpoint is disabled

filter_typesstring[] nullable required

List of event types being filtered, or null for all events

channelsstring[] nullable required

Webhook channels

headersobject

Deprecated compatibility field. Stored header values are never returned; use header_names instead.

secretstring required

Webhook signing secret. Returned exactly once when the endpoint is created

header_namesstring[]

Names of configured custom headers. Header values are never returned

integration_idstring

Safe integration identifier derived from the managed integration header. Other header values are never returned

format'superwall' | 'superwall_v2'

Which webhook delivery format this endpoint belongs to (superwall or superwall_v2)

created_atstring required

ISO 8601 timestamp of when the endpoint was created

updated_atstring required

ISO 8601 timestamp of when the endpoint was last updated

Changes

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