POST
/
apps
/
{app_id}
/
integrations
/
custom_events
curl --request POST \
  --url https://api.onesignal.com/apps/{app_id}/integrations/custom_events \
  --header 'Content-Type: application/json' \
  --data '{
  "events": [
    {
      "name": "<string>",
      "external_id": "<string>",
      "onesignal_id": "<string>",
      "timestamp": "<string>",
      "payload": {}
    }
  ]
}'
"{}"

This feature is in beta and subject to change. Contact support@onesignal.com to request access.

​
Overview

The Custom Events API allows you to track user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones.

​
Use Cases

Custom events can be used to:

  • Enter users into Journeys and trigger Journey Wait Until nodes.

​
Early Access

Please reach out to your customer success manager to be granted early access to the custom events api.

Headers

​
Authorization
string
default:Key YOUR_APP_API_KEY

Your app API key with prefix Key. See Keys & IDs.

Path Parameters

​
app_id
string
required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

Body

application/json

Response

200
application/json

200

The response is of type object.