Get an alert by its ID

GET

/v:version/alerts/:resourceId

GET

/v:version/alerts/:resourceId

1 curl https://test.api.solvimon.com/v1/alerts/ \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json"

1 {
2   "platform_id": "platform-987654321",
3   "alert_rule_id": "rule-1234abcd",
4   "customer_id": "cust-5678efgh",
5   "type": "ENTITLEMENT",
6   "object_type": "alert",
7   "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
8   "created_at": "2024-06-01T12:00:00Z",
9   "alert_rule": {
10     "reference": "AR-20240601",
11     "object_type": "alert_rule",
12     "id": "rule-1234abcd",
13     "name": "Overdue Invoice Alert",
14     "description": "Triggers when an invoice is overdue by a specified number of days",
15     "status": "ACTIVE",
16     "customer_ids": [
17       "cust-5678efgh"
18     ],
19     "customers": [
20       {
21         "reference": "CUST-5678",
22         "type": "ORGANIZATION",
23         "email": "contact@acmecorp.com",
24         "roles": [
25           "DEFAULT"
26         ],
27         "object_type": "customer",
28         "id": "cust-5678efgh",
29         "created_at": "2023-11-15T08:45:00Z",
30         "parent_customer_id": "org-4321dcba",
31         "parent_customer_ids": [
32           "org-4321dcba"
33         ],
34         "status": "ACTIVE",
35         "timezone": "America/New_York",
36         "notification_preferences": [
37           {
38             "type": "INVOICE",
39             "channels": [
40               {
41                 "type": "EMAIL",
42                 "enabled": true
43               }
44             ]
45           }
46         ],
47         "locale": "en-US",
48         "individual": {
49           "name": {
50             "first_name": "John",
51             "last_name": "Doe",
52             "infix": ""
53           },
54           "residential_address": {
55             "line1": "123 Maple Street",
56             "line2": "Suite 400",
57             "city": "Springfield",
58             "postal_code": "01103",
59             "state": "MA",
60             "country": "US"
61           }
62         },
63         "organization": {
64           "legal_name": "Acme Corporation",
65           "tax_id": "12-3456789",
66           "tax_ids": [
67             {
68               "id": "12-3456789",
69               "type": "EIN"
70             }
71           ],
72           "registration_number": "REG-987654",
73           "tax_exempt": false,
74           "tax_exempt_note": "",
75           "registered_address": {
76             "line1": "456 Industrial Way",
77             "line2": "",
78             "city": "Springfield",
79             "postal_code": "01104",
80             "state": "MA",
81             "country": "US"
82           }
83         },
84         "custom_fields": [
85           {
86             "id": "cf-001",
87             "reference": "preferred_contact",
88             "value": "email",
89             "values": [
90               "email",
91               "phone"
92             ],
93             "integration_details": {
94               "payment_gateway_variant": "ADYEN",
95               "id": "int-123",
96               "reference": "gateway-adyen",
97               "adyen": {
98                 "recurring_detail_reference": "rec-7890"
99               },
100               "stripe": {
101                 "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3xYz"
102               }
103             }
104           }
105         ],
106         "processing_only": false,
107         "pricing_plan_subscription_selector": {
108           "data": [
109             {
110               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
111               "value": "US"
112             }
113           ],
114           "rules": [
115             {
116               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
117               "type": "EQUALS"
118             }
119           ],
120           "filters": [
121             {
122               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
123               "type": "EQUALS",
124               "value": "US"
125             }
126           ],
127           "fallback": "LATEST"
128         },
129         "linked_integrations": [
130           {
131             "id": "int-123",
132             "link_details": [
133               {
134                 "url": "https://dashboard.adyen.com",
135                 "custom_field_name": "adyen_account"
136               }
137             ]
138           }
139         ]
140       }
141     ],
142     "type": "ENTITLEMENT",
143     "trigger_type": "STATIC",
144     "entitlement": {
145       "feature_id": "feat-001",
146       "comparator": "EQUALS",
147       "feature": {
148         "reference": "FEATURE-ENTITLEMENT-001",
149         "object_type": "feature",
150         "id": "feat-001",
151         "name": "Premium Support Access",
152         "description": "Access to premium support features",
153         "type": "SWITCH",
154         "enum_values": [
155           "ENABLED",
156           "DISABLED"
157         ],
158         "meter_value_calculation_id": "calc-001",
159         "meter_value_calculation": {
160           "reference": "CALC-SUM-001",
161           "object_type": "calculation",
162           "id": "calc-001",
163           "name": "Sum of Support Tickets",
164           "description": "Calculates total support tickets used",
165           "calculation_type": "SUM",
166           "persist": true,
167           "meter_id": "meter-001",
168           "meter": {
169             "reference": "METER-SUPPORT-TICKETS",
170             "object_type": "meter",
171             "id": "meter-001",
172             "name": "Support Tickets Meter",
173             "description": "Tracks number of support tickets used",
174             "status": "ACTIVE",
175             "meter_values": [
176               {
177                 "id": "mv-001",
178                 "object": {
179                   "reference": "MV-SUPPORT-TICKETS",
180                   "object_type": "meter_value",
181                   "id": "mv-001",
182                   "name": "Support Tickets Count",
183                   "description": "Count of support tickets",
184                   "status": "ACTIVE",
185                   "type": "NUMBER"
186                 },
187                 "required": true
188               }
189             ],
190             "meter_properties": [
191               {
192                 "id": "mp-001",
193                 "object": {
194                   "reference": "MP-TICKET-PRIORITY",
195                   "status": "ACTIVE",
196                   "object_type": "meter_property",
197                   "id": "mp-001",
198                   "name": "Ticket Priority",
199                   "description": "Priority level of tickets",
200                   "type": "NUMBER",
201                   "enum_values": [
202                     "1",
203                     "2",
204                     "3"
205                   ]
206                 },
207                 "required": true
208               }
209             ]
210           },
211           "meter_value_id": "mv-001",
212           "meter_value": {
213             "reference": "MV-SUPPORT-TICKETS",
214             "object_type": "meter_value",
215             "id": "mv-001",
216             "name": "Support Tickets Count",
217             "description": "Count of support tickets",
218             "status": "ACTIVE",
219             "type": "NUMBER"
220           },
221           "meter_property_id": "mp-001",
222           "meter_property": {
223             "reference": "MP-TICKET-PRIORITY",
224             "status": "ACTIVE",
225             "object_type": "meter_property",
226             "id": "mp-001",
227             "name": "Ticket Priority",
228             "description": "Priority level of tickets",
229             "type": "NUMBER",
230             "enum_values": [
231               "1",
232               "2",
233               "3"
234             ]
235           }
236         }
237       },
238       "threshold": {
239         "number": "10",
240         "percentage": "0.0",
241         "amount": {
242           "quantity": "0",
243           "currency": "AED"
244         }
245       }
246     },
247     "invoice": {
248       "variant": "OVERDUE",
249       "overdue": {
250         "comparator": "GREATER_THAN",
251         "threshold": {
252           "type": "DAY",
253           "value": 5
254         }
255       }
256     }
257   },
258   "customer": {
259     "reference": "CUST-5678",
260     "type": "ORGANIZATION",
261     "email": "contact@acmecorp.com",
262     "roles": [
263       "DEFAULT"
264     ],
265     "object_type": "customer",
266     "id": "cust-5678efgh",
267     "created_at": "2023-11-15T08:45:00Z",
268     "parent_customer_id": "org-4321dcba",
269     "parent_customer_ids": [
270       "org-4321dcba"
271     ],
272     "status": "ACTIVE",
273     "timezone": "America/New_York",
274     "notification_preferences": [
275       {
276         "type": "INVOICE",
277         "channels": [
278           {
279             "type": "EMAIL",
280             "enabled": true
281           }
282         ]
283       }
284     ],
285     "locale": "en-US",
286     "individual": {
287       "name": {
288         "first_name": "John",
289         "last_name": "Doe",
290         "infix": ""
291       },
292       "residential_address": {
293         "line1": "123 Maple Street",
294         "line2": "Suite 400",
295         "city": "Springfield",
296         "postal_code": "01103",
297         "state": "MA",
298         "country": "US"
299       }
300     },
301     "organization": {
302       "legal_name": "Acme Corporation",
303       "tax_id": "12-3456789",
304       "tax_ids": [
305         {
306           "id": "12-3456789",
307           "type": "EIN"
308         }
309       ],
310       "registration_number": "REG-987654",
311       "tax_exempt": false,
312       "tax_exempt_note": "",
313       "registered_address": {
314         "line1": "456 Industrial Way",
315         "line2": "",
316         "city": "Springfield",
317         "postal_code": "01104",
318         "state": "MA",
319         "country": "US"
320       }
321     },
322     "custom_fields": [
323       {
324         "id": "cf-001",
325         "reference": "preferred_contact",
326         "value": "email",
327         "values": [
328           "email",
329           "phone"
330         ],
331         "integration_details": {
332           "payment_gateway_variant": "ADYEN",
333           "id": "int-123",
334           "reference": "gateway-adyen",
335           "adyen": {
336             "recurring_detail_reference": "rec-7890"
337           },
338           "stripe": {
339             "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3xYz"
340           }
341         }
342       }
343     ],
344     "processing_only": false,
345     "pricing_plan_subscription_selector": {
346       "data": [
347         {
348           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
349           "value": "US"
350         }
351       ],
352       "rules": [
353         {
354           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
355           "type": "EQUALS"
356         }
357       ],
358       "filters": [
359         {
360           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
361           "type": "EQUALS",
362           "value": "US"
363         }
364       ],
365       "fallback": "LATEST"
366     },
367     "linked_integrations": [
368       {
369         "id": "int-123",
370         "link_details": [
371           {
372             "url": "https://dashboard.adyen.com",
373             "custom_field_name": "adyen_account"
374           }
375         ]
376       }
377     ]
378   },
379   "data_trigger_reference": "TRIGGER-20240601-001",
380   "alert_data": {
381     "entitlement": {
382       "pricing_plan_subscription_id": "sub-7890abcd",
383       "entitlement_value": {
384         "number": "10",
385         "amount": {
386           "quantity": "0",
387           "currency": "AED"
388         }
389       },
390       "threshold_value": {
391         "number": "10",
392         "amount": {
393           "quantity": "0",
394           "currency": "AED"
395         }
396       },
397       "used_value": {
398         "number": "7",
399         "amount": {
400           "quantity": "0",
401           "currency": "AED"
402         }
403       }
404     },
405     "invoice": {
406       "id": "inv-20240601-001",
407       "overdue": {
408         "due_date": "2024-01-15T09:30:00Z",
409         "overdue_period": {
410           "type": "DAY",
411           "value": 7
412         }
413       }
414     }
415   }
416 }

Requires the ALERT.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.

Query parameters

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

Response

platform_idstring

Resource ID of type PLATFORM

alert_rule_idstring

Resource ID of type ALERT_RULE

customer_idstring

Resource ID of type CUSTOMER

typeenum

Allowed values:

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

alert_ruleobject or null

customerobject or null

data_trigger_referencestring or null

alert_dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors