Skip to main content
POST
https://api-staging.withbenji.com
/
partnerships
/
{partnership_id}
/
triggers
Send Trigger Event
curl --request POST \
  --url https://api-staging.withbenji.com/partnerships/{partnership_id}/triggers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "trigger_name": "<string>",
  "external_user_id": "<string>",
  "user_id": "<string>",
  "transaction_context": {}
}
'
{
  "trigger_event_id": "<string>"
}
The x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.
​
partnership_id
string
required
The unique identifier of the partnership associated with this trigger event.
​
trigger_name
string
required
The name of the trigger event to process. This identifies the type of event being triggered (e.g., ‘user_signup’, ‘transaction_completed’). Trigger name can be found in the triggers section of the Pilot dashboard.
​
external_user_id
string
Your external identifier of the user. Used to map the event to a specific user in the Benji platform.
​
user_id
string
The unique identifier of the user associated with this trigger event.
​
transaction_context
object
Additional context data about the transaction that triggered this event. Contains partner-specific information about the transaction details as configured on the trigger in the triggers section on Pilot.

​
Response

​
trigger_event_id
string
required
The UUID of the trigger event. This is the preferred identifier for referencing the trigger event.
Trigger events are used to activate campaign flows and generate rewards for users. Make sure the trigger is configured in your partnership settings before sending events.