SUsuperwall
Users V2

Retrieve User Event

Changed on

Retrieves a single event by ID. The application_id query parameter is required for authorization. Requires users:read scope.

get/v2/users/events/{event_id}

Request

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

Path parameters

event_idstring required

Event ID

Query parameters

application_idstring required

Response

Success

idstring required

Unique event identifier

timestampstring required

ISO 8601 timestamp of when the event occurred

namestring required

Event name

sourcestring required

Human-readable source label for the event (e.g. integration name, SDK version)

propertiesSuperwallApiSchemaV2JsonObject required
app_user_idstring nullable
app_versionstring nullable
platformstring nullable
device_localestring nullable
inserted_atstring
headersstring nullable
event_source'subscription' | 'sdk' required

Categorized event origin: 'subscription' for payment/billing events, 'sdk' for client SDK events

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

    • 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

  • 217c96dc9a29Revision changes
    • 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 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

    This list may be incomplete.