Skip to main content
POST
/
api
/
customEvents.import
Import custom events
curl --request POST \
  --url https://{notifuseDomain}/api/customEvents.import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "events": [
    {
      "event_name": "orders/fulfilled",
      "external_id": "shopify_order_12345",
      "email": "[email protected]",
      "properties": {
        "order_total": 129.99,
        "product_name": "Premium Subscription"
      },
      "occurred_at": "2023-05-15T14:30:00Z"
    },
    {
      "event_name": "payment/succeeded",
      "external_id": "stripe_payment_67890",
      "email": "[email protected]",
      "properties": {
        "amount": 129.99,
        "currency": "USD"
      },
      "occurred_at": "2023-05-15T14:29:00Z"
    }
  ]
}
'
{
  "event_ids": [
    "shopify_order_12345",
    "stripe_payment_67890"
  ],
  "count": 2
}

Authorizations

​
Authorization
string
header
required

API token for authentication

Body

application/json
​
workspace_id
string
required

The ID of the workspace

Example:

"ws_1234567890"

​
events
object[]
required

Array of custom events to import (1-50 events)

Required array length: 1 - 50 elements
Example:
[
  {
    "event_name": "orders/fulfilled",
    "external_id": "shopify_order_12345",
    "email": "[email protected]",
    "properties": {
      "order_total": 129.99,
      "product_name": "Premium Subscription"
    },
    "occurred_at": "2023-05-15T14:30:00Z"
  },
  {
    "event_name": "payment/succeeded",
    "external_id": "stripe_payment_67890",
    "email": "[email protected]",
    "properties": { "amount": 129.99, "currency": "USD" },
    "occurred_at": "2023-05-15T14:29:00Z"
  }
]

Response

Custom events imported successfully

​
event_ids
string[]

External IDs of successfully imported events

Example:
[
  "shopify_order_12345",
  "stripe_payment_67890"
]
​
count
integer

Number of events created

Example:

2