App Store Connect Configurations V25

App User Erasures V24

Application Webapp Origins V23

Assets V26

Audit Logs V22

Campaigns V234

Chart Annotations5

Charts V28

CLI Agent V22

Custom Store Events1

Custom Stores8

Demand Score V23

Entitlements V28

Events V24

Google Play V28

Grants V21

Imports1

Integration Event Names (Service)1

Me V25

Notifications1

Onboarding V21

Organization Access V211

Organizations V22

Paywall Resolver (Public)2

Paywall Templates (Public)1

Paywalls V217

Products V211

Project Auth V26

Project Transfers V27

Projects V224

Query V22

Retention Configurations V212

Retention Default Messages V29

Retention Messages V211

Retention Messaging Onboarding V28

retentionCampaignsV29

RevenueCat V1 (compatible)1

RevenueCat V2 (compatible)4

Stripe Customer Links V21

Surveys V212

Users V214

Users V34

Web2App Integrations V25

Webhooks V212

WorkOS Organization Admin1

Webhooks V2

Update Webhook Endpoint

Changed on Oct 29, 2026

Updates a webhook endpoint's URL, description, or other settings. Requires webhooks:write scope.

patch/v2/projects/{project_id}/webhook_endpoints/{endpoint_id}

Request

Base URL
https://api.superwall.com
URL
https://api.superwall.com/v2/projects/{project_id}/webhook_endpoints/{endpoint_id}
Auth
- HTTP bearer
- or API key in cookie accounts_superwall_token
- or HTTP bearer

Path parameters

project_idstring required

endpoint_idstring required

Webhook endpoint ID

Query parameters

format'superwall' | 'superwall_v2'

Request body

urlstring

The URL where webhook events will be sent

descriptionstring nullable

Description of the webhook endpoint

filter_typesstring[]

List of event types to filter

disabledboolean

Whether the webhook endpoint is disabled

metadataobject

Arbitrary key-value metadata

headersobject

Custom headers to include with webhook requests

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

Deprecated compatibility field. Omitted from ordinary endpoint responses; signing secrets are returned only on creation or rotation.

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

Oct 29, 2026778a11cd2c15 Revision changes
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- warning
  added the new credentials_missing enum value to the / response property for the response status
- info
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status
- info
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status
Sep 9, 2026217c96dc9a29 Revision changes
- breaking
  removed the enum value superwall from the query request parameter format
- breaking
  removed the enum value superwall_v2 from the query request parameter format
- breaking
  removed subschema #1 subschema #2 from the request property anyOf list
- breaking
  the request property type changed from boolean to no type
- breaking
  the request property type changed from array to no type
- breaking
  the request property type changed from object to no type
- breaking
  the request property type changed from object to no type
- breaking
  the request property type changed from string to no type
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from array to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from number to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from string to no type for status
- breaking
  the response's property type changed from number to no type for status
This list may be incomplete.

Operation history