DocumentationDocumentation
DocumentationFrameworkCommunityAPI Reference
Sign InSign Up

GitHubnovuhq/novu

38.1K

Bulk trigger event

Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.

POST/v1/events/trigger/bulk

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

In: header

Request Body

application/jsonRequired
eventsRequiredarray<object>

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X POST "https://api.novu.co/v1/events/trigger/bulk" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      {
        "name": "workflow_identifier",
        "payload": {
          "comment_id": "string",
          "post": {
            "text": "string"
          }
        },
        "overrides": {
          "fcm": {
            "data": {
              "key": "value"
            }
          }
        },
        "to": [
          {
            "subscriberId": "string",
            "email": "string",
            "firstName": "string",
            "lastName": "string",
            "phone": "string",
            "avatar": "string",
            "locale": "string",
            "data": {
              "property1": "string",
              "property2": "string"
            },
            "channels": [
              {
                "providerId": "slack",
                "integrationIdentifier": "string",
                "credentials": {
                  "webhookUrl": "string",
                  "deviceTokens": [
                    "string"
                  ]
                }
              }
            ],
            "timezone": "string"
          }
        ],
        "transactionId": "string",
        "actor": "string",
        "tenant": "string",
        "context": {
          "property1": "org-acme",
          "property2": "org-acme"
        }
      }
    ]
  }'

Created

[
  {
    "acknowledged": true,
    "status": "error",
    "error": [
      "string"
    ],
    "transactionId": "string"
  }
]

Edit on GitHub

Previous

Trigger event POST

Next

Cancel triggered event DELETE