Get workflow trigger by ID | Solvimon

curl https://api.solvimon.com/v1/workflow-triggers/ \
     -H "X-API-KEY: <apiKey>"

{
  "workflow_id": "string",
  "type": "MANUAL",
  "object_type": "string",
  "id": "string",
  "customer_id": "string",
  "invoice": {
    "invoice_id": "string",
    "event": {
      "variant": "TO_FINAL",
      "overdue": {
        "period": {
          "type": "DAY",
          "value": 1
        }
      }
    },
    "manual": {
      "variant": "TO_FINAL",
      "user_id": "string",
      "overdue": {
        "period": {
          "type": "DAY",
          "value": 1
        }
      }
    }
  },
  "payment": {
    "payment_id": "string",
    "event": {
      "variant": "FAILED_PAYMENT"
    },
    "manual": {
      "variant": "FAILED_PAYMENT",
      "user_id": "string"
    }
  }
}

Fetches a single workflow trigger by resource ID. Requires the WORKFLOW_TRIGGER.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

workflow_idstring

Workflow executed by this trigger.

typeenum

Source of the trigger execution, such as a manual request or a system event.

Allowed values:

object_typestring or nullRead-only

idstring or nullRead-only

customer_idstring or null

Customer scope associated with the trigger execution.

invoiceobject

Invoice trigger details for executions that run on an invoice.

paymentobject

Payment trigger details for executions that run on a payment.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Response

Errors