Skip to main content
Version - 1.0

{
  "eventType": "WORKFLOW_RUN.FAILED",
  "version": "1.0",
  "date": "2024-02-21 15:36:16.167687",
  "primerAccountId": "123abcde-99f2-416e-8013-6ecd1c1285c3",
  "triggerEventId": "DdRZ6YY0",
  "workflow": {
    "id": "ecb8d3bc-123a-4d56-826e-ef8d4cc3d2a2",
    "name": "MIT UK Card",
    "version": 8
  },
  "run": {
    "timestamp": "2024-03-07T12:20:14.394429",
    "id": "bbb1c3cc-805d-4d97-826e-ef8d4cc3d2a2",
    "status": "FAILED",
    "lastError": {
      "applicationId": "PRIMER_PAYMENTS",
      "actionId": "capture_payment",
      "diagnosticsId": "1234567890",
      "message": "Payment ID not found."
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://primer.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Version - 1.0

{
  "eventType": "WORKFLOW_RUN.FAILED",
  "version": "1.0",
  "date": "2024-02-21 15:36:16.167687",
  "primerAccountId": "123abcde-99f2-416e-8013-6ecd1c1285c3",
  "triggerEventId": "DdRZ6YY0",
  "workflow": {
    "id": "ecb8d3bc-123a-4d56-826e-ef8d4cc3d2a2",
    "name": "MIT UK Card",
    "version": 8
  },
  "run": {
    "timestamp": "2024-03-07T12:20:14.394429",
    "id": "bbb1c3cc-805d-4d97-826e-ef8d4cc3d2a2",
    "status": "FAILED",
    "lastError": {
      "applicationId": "PRIMER_PAYMENTS",
      "actionId": "capture_payment",
      "diagnosticsId": "1234567890",
      "message": "Payment ID not found."
    }
  }
}

Headers

​
X-Signature-Primary
string

An HMAC signature generated using the webhook payload and a shared signing secret. This is then converted to a base64 encoded string. Only present when webhook signing is enabled in the dashboard.

​
X-Signature-Secondary
string

A secondary signature that is added when you have rotated your secret within the past 24 hours.

Body

application/json
​
eventType
enum<string>
required

The type of the webhook raised. WORKFLOW_RUN.FAILED for failed workflow runs. Additional types may be supported in the future.

Available options:
WORKFLOW_RUN.FAILED
​
version
string
required

The payload version for this eventType.

Example:

"1.0"

​
date
string
required

The date and time when the webhook event was sent.

Example:

"2024-02-21 15:36:16.167687"

​
primerAccountId
string<uuid>
required

The Primer Account ID of the account that owns the failed workflow run.

​
workflow
Workflow · object
required

Details of the workflow that had a failed run.

​
run
Run · object
required

Details of the workflow run that failed.

​
triggerEventId
string | null

An optional ID passed with the trigger to identify the origin of the event that started the workflow. For payment workflows this is the payment ID; other triggers may not set an event ID, in which case this value will be null.

Response

200

Return a 200 status to indicate that the data was received successfully