SUsuperwall
Events V2

Retrieve Event

Changed on

Retrieves an event by ID. Requires webhooks:read scope.

get/v2/projects/{project_id}/events/{event_id}

Request

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

Path parameters

project_idstring required
event_idstring required

Event ID

Query parameters

format'superwall' | 'superwall_v2'

Which webhook delivery application the event belongs to: superwall (default) or superwall_v2.

Response

Success

idstring required

Unique identifier for the event

object'event' required

Object type, always event

event_typestring required

Type of the event

event_idstring nullable required

External event ID, or null

channelsstring[] nullable required

Channels the event was sent to

payloadobject required

Event payload data

timestampstring required

ISO 8601 timestamp of when the event occurred

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