Get workflow trigger by ID

GET

/v:version/workflow-triggers/:resourceId

GET

/v:version/workflow-triggers/:resourceId

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

1 {
2   "object_type": "string",
3   "id": "string",
4   "customer_id": "string",
5   "workflow_id": "string",
6   "type": "MANUAL",
7   "invoice": {
8     "invoice_id": "string",
9     "event": {
10       "variant": "TO_FINAL",
11       "overdue": {
12         "period": {
13           "type": "DAY",
14           "value": 1
15         }
16       }
17     },
18     "manual": {
19       "user_id": "string",
20       "variant": "TO_FINAL",
21       "overdue": {
22         "period": {
23           "type": "DAY",
24           "value": 1
25         }
26       }
27     }
28   },
29   "payment": {
30     "payment_id": "string",
31     "event": {
32       "variant": "FAILED_PAYMENT"
33     },
34     "manual": {
35       "user_id": "string",
36       "variant": "FAILED_PAYMENT"
37     }
38   },
39   "pricing_plan_subscription": {
40     "pricing_plan_subscription_id": "string",
41     "pricing_plan_schedule_id": "string",
42     "trial_end_at": "2024-01-15T09:30:00Z",
43     "event": {
44       "variant": "FREE_TRIAL_REMINDER"
45     },
46     "manual": {
47       "user_id": "string",
48       "variant": "FREE_TRIAL_REMINDER"
49     }
50   },
51   "wallet": {
52     "wallet_type_id": "string",
53     "wallet_id": "string",
54     "customer_reference": "string",
55     "wallet_reference": "string",
56     "event": {
57       "variant": "WALLET_BALANCE"
58     }
59   },
60   "usage": {
61     "meter_value_calculation_id": "string",
62     "event": {
63       "variant": "USAGE_LIMIT",
64       "customer_id": "string",
65       "parent_customer_id": "string",
66       "threshold": "string",
67       "threshold_type": "string",
68       "limit": "string",
69       "consumed": "string",
70       "period_start": "string",
71       "period_end": "string"
72     }
73   }
74 }

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

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

customer_idstring or nullOptional

Customer scope associated with the trigger execution.

workflow_idstringOptional

Workflow executed by this trigger.

typeenumOptional

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

invoiceobjectOptional

Invoice trigger details for executions that run on an invoice.

paymentobjectOptional

Payment trigger details for executions that run on a payment.

pricing_plan_subscriptionobjectOptional

Pricing plan subscription trigger details for executions that run on a subscription.

walletobjectOptional

Wallet trigger details for executions that run on a wallet balance event.

usageobjectOptional

Usage trigger details for executions that run on a usage event.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Response

Errors