Skip to main content
POST
/
partnerships
/
{partnership_id}
/
triggers
Process a trigger event for a partnership.
curl --request POST \
  --url https://campaignservice-staging.withbenji.com/partnerships/{partnership_id}/triggers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "trigger_name": "<string>",
  "external_user_id": null,
  "partnership_id": 123,
  "user_id": null,
  "transaction_context": null
}
'
{
  "trigger_event_id": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
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').

​
external_user_id
string | null

Your external identifier of the user. Used to map the event to a specific user in the Benji platform.

​
partnership_id
integer

The unique identifier of the partnership associated with this trigger event.

​
user_id
integer | null

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

OK

​
trigger_event_id
integer
required

The ID of the trigger event