v1

latestOpenAPI 3.1.02026-07-227350156.5 KB

Merchant Action Triggers

Get program-level trigger status

Get the status and version of the latest merchant action trigger registration at the program scope.

Program-level triggers apply to all enrichment requests where the programId field matches this program. See What is a program? for more details.

Important: Triggers are only applied to enrichment responses when the status is succeeded.

To learn more about action triggers, please read the Merchant Action Triggers Guide.

get/programs/{programId}/merchant-action-triggers

Response

Successful operation

status'pending' | 'running' | 'succeeded' | 'failed'

The current status of the action trigger registration.

pending: Registration received, processing not yet started
running: Registration is being processed (for batch registrations with >100 triggers)
succeeded: Registration complete, triggers are now active
failed: Registration failed, check your request and retry

versioninteger

The version number of this registration. Increments with each PUT, PATCH, or DELETE request to this scope.

totalCountinteger

The total number of active merchant triggers registered for this scope. Present on GET responses; omitted on PUT and PATCH responses.

Example response

{
  "status": "succeeded",
  "version": 1,
  "merchantTriggers": [
    {
      "id": "merchant_123",
      "action": {
        "type": "REWARD",
        "points": 200
      }
    }
  ],
  "totalCount": 50000
}