SUsuperwall
Events V2

List Events

Changed on

Returns a list of events (webhook messages) for the project. Supports pagination and filtering. Requires webhooks:read scope.

get/v2/projects/{project_id}/events

Request

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

Path parameters

project_idstring required

Query parameters

limitstring
iteratorstring

Pagination cursor

channelstring

Filter by channel

beforestring

Return events before this date

afterstring

Return events after this date

with_content'true' | 'false'
tagstring

Filter by tag

event_typesstring[]

Filter by event types

format'superwall' | 'superwall_v2'

Which webhook delivery application to list events from: superwall (default) or superwall_v2.

Response

Success

object'list' required

Object type, always list

has_moreboolean required

Whether there are more results available

iteratorstring

Cursor for forward pagination

prev_iteratorstring

Cursor for backward pagination

Changes

  • 778a11cd2c15Revision 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

  • 882b8ce1ff7aRevision changes
    • info

      added the new optional query request parameter format