Create an alert

POST

/v:version/alerts

POST

/v:version/alerts

1 curl -X POST https://test.api.solvimon.com/v1/alerts \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "platform_id": "string",
6   "alert_rule_id": "string",
7   "customer_id": "string",
8   "type": "ENTITLEMENT"
9 }'

1 {
2   "platform_id": "string",
3   "alert_rule_id": "string",
4   "customer_id": "string",
5   "type": "ENTITLEMENT",
6   "object_type": "string",
7   "id": "string",
8   "created_at": "string",
9   "alert_rule": {
10     "reference": "string",
11     "object_type": "string",
12     "id": "string",
13     "name": "string",
14     "description": "string",
15     "status": "DRAFT",
16     "customer_ids": [
17       "string"
18     ],
19     "customers": [
20       {
21         "reference": "string",
22         "type": "ORGANIZATION",
23         "email": "string",
24         "roles": [
25           "DEFAULT"
26         ],
27         "object_type": "string",
28         "id": "string",
29         "created_at": "string",
30         "parent_customer_id": "string",
31         "parent_customer_ids": [
32           "string"
33         ],
34         "status": "DRAFT",
35         "timezone": "string",
36         "notification_preferences": [
37           {
38             "type": "INVOICE",
39             "channels": [
40               {
41                 "type": "EMAIL",
42                 "enabled": true
43               }
44             ]
45           }
46         ],
47         "locale": "string",
48         "individual": {
49           "name": {
50             "first_name": "string",
51             "last_name": "string",
52             "infix": "string"
53           },
54           "residential_address": {
55             "line1": "string",
56             "line2": "string",
57             "city": "string",
58             "postal_code": "string",
59             "state": "string",
60             "country": "AD"
61           }
62         },
63         "organization": {
64           "legal_name": "string",
65           "tax_id": "string",
66           "tax_ids": [
67             {
68               "id": "string",
69               "type": "GENERIC_TAX_ID",
70               "tax_id_validation_result": {
71                 "id": "string",
72                 "validation_date": "string",
73                 "source": "string",
74                 "valid": "VALID",
75                 "message": "string"
76               }
77             }
78           ],
79           "registration_number": "string",
80           "tax_exempt": true,
81           "tax_exempt_note": "string",
82           "registered_address": {
83             "line1": "string",
84             "line2": "string",
85             "city": "string",
86             "postal_code": "string",
87             "state": "string",
88             "country": "AD"
89           },
90           "tax_registrations": [
91             {
92               "id": "string",
93               "description": "string",
94               "tax_id": "string",
95               "tax_ids": [
96                 {
97                   "id": "string",
98                   "type": "GENERIC_TAX_ID",
99                   "tax_id_validation_result": {
100                     "id": "string",
101                     "validation_date": "string",
102                     "source": "string",
103                     "valid": "VALID",
104                     "message": "string"
105                   }
106                 }
107               ],
108               "registration_number": "string",
109               "registered_address": {
110                 "line1": "string",
111                 "line2": "string",
112                 "city": "string",
113                 "postal_code": "string",
114                 "state": "string",
115                 "country": "AD"
116               }
117             }
118           ]
119         },
120         "custom_fields": [
121           {
122             "id": "string",
123             "reference": "string",
124             "value": "string",
125             "values": [
126               "string"
127             ],
128             "integration_details": {
129               "payment_gateway_variant": "ADYEN",
130               "id": "string",
131               "reference": "string",
132               "adyen": {
133                 "recurring_detail_reference": "string"
134               },
135               "stripe": {
136                 "payment_method_id": "string"
137               }
138             }
139           }
140         ],
141         "processing_only": true,
142         "pricing_plan_subscription_selector": {
143           "data": [
144             {
145               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
146               "value": "string"
147             }
148           ],
149           "rules": [
150             {
151               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
152               "type": "EQUALS"
153             }
154           ],
155           "filters": [
156             {
157               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
158               "type": "EQUALS",
159               "value": "string"
160             }
161           ],
162           "fallback": "LATEST"
163         },
164         "linked_integrations": [
165           {
166             "id": "string",
167             "link_details": [
168               {
169                 "url": "string",
170                 "custom_field_name": "string"
171               }
172             ]
173           }
174         ]
175       }
176     ],
177     "type": "ENTITLEMENT",
178     "trigger_type": "STATIC",
179     "entitlement": {
180       "feature_id": "string",
181       "comparator": "EQUALS",
182       "feature": {
183         "reference": "string",
184         "object_type": "string",
185         "id": "string",
186         "name": "string",
187         "description": "string",
188         "type": "SWITCH",
189         "enum_values": [
190           "string"
191         ],
192         "meter_value_calculation_id": "string",
193         "meter_value_calculation": {
194           "reference": "string",
195           "object_type": "string",
196           "id": "string",
197           "name": "string",
198           "description": "string",
199           "calculation_type": "SUM",
200           "persist": true,
201           "meter_id": "string",
202           "meter": {
203             "reference": "string",
204             "object_type": "string",
205             "id": "string",
206             "name": "string",
207             "description": "string",
208             "status": "DRAFT",
209             "meter_values": [
210               {
211                 "id": "string",
212                 "object": {
213                   "reference": "string",
214                   "object_type": "string",
215                   "id": "string",
216                   "name": "string",
217                   "description": "string",
218                   "status": "DRAFT",
219                   "type": "NUMBER"
220                 },
221                 "required": true
222               }
223             ],
224             "meter_properties": [
225               {
226                 "id": "string",
227                 "object": {
228                   "reference": "string",
229                   "status": "DRAFT",
230                   "object_type": "string",
231                   "id": "string",
232                   "name": "string",
233                   "description": "string",
234                   "type": "NUMBER",
235                   "enum_values": [
236                     "string"
237                   ]
238                 },
239                 "required": true
240               }
241             ]
242           },
243           "meter_value_id": "string",
244           "meter_value": {
245             "reference": "string",
246             "object_type": "string",
247             "id": "string",
248             "name": "string",
249             "description": "string",
250             "status": "DRAFT",
251             "type": "NUMBER"
252           },
253           "meter_property_id": "string",
254           "meter_property": {
255             "reference": "string",
256             "status": "DRAFT",
257             "object_type": "string",
258             "id": "string",
259             "name": "string",
260             "description": "string",
261             "type": "NUMBER",
262             "enum_values": [
263               "string"
264             ]
265           }
266         }
267       },
268       "threshold": {
269         "number": "string",
270         "percentage": "string",
271         "amount": {
272           "quantity": "string",
273           "currency": "AED"
274         }
275       }
276     },
277     "invoice": {
278       "variant": "OVERDUE",
279       "overdue": {
280         "comparator": "EQUALS",
281         "threshold": {
282           "type": "DAY",
283           "value": 1
284         }
285       }
286     }
287   },
288   "customer": {
289     "reference": "string",
290     "type": "ORGANIZATION",
291     "email": "string",
292     "roles": [
293       "DEFAULT"
294     ],
295     "object_type": "string",
296     "id": "string",
297     "created_at": "string",
298     "parent_customer_id": "string",
299     "parent_customer_ids": [
300       "string"
301     ],
302     "status": "DRAFT",
303     "timezone": "string",
304     "notification_preferences": [
305       {
306         "type": "INVOICE",
307         "channels": [
308           {
309             "type": "EMAIL",
310             "enabled": true
311           }
312         ]
313       }
314     ],
315     "locale": "string",
316     "individual": {
317       "name": {
318         "first_name": "string",
319         "last_name": "string",
320         "infix": "string"
321       },
322       "residential_address": {
323         "line1": "string",
324         "line2": "string",
325         "city": "string",
326         "postal_code": "string",
327         "state": "string",
328         "country": "AD"
329       }
330     },
331     "organization": {
332       "legal_name": "string",
333       "tax_id": "string",
334       "tax_ids": [
335         {
336           "id": "string",
337           "type": "GENERIC_TAX_ID",
338           "tax_id_validation_result": {
339             "id": "string",
340             "validation_date": "string",
341             "source": "string",
342             "valid": "VALID",
343             "message": "string"
344           }
345         }
346       ],
347       "registration_number": "string",
348       "tax_exempt": true,
349       "tax_exempt_note": "string",
350       "registered_address": {
351         "line1": "string",
352         "line2": "string",
353         "city": "string",
354         "postal_code": "string",
355         "state": "string",
356         "country": "AD"
357       },
358       "tax_registrations": [
359         {
360           "id": "string",
361           "description": "string",
362           "tax_id": "string",
363           "tax_ids": [
364             {
365               "id": "string",
366               "type": "GENERIC_TAX_ID",
367               "tax_id_validation_result": {
368                 "id": "string",
369                 "validation_date": "string",
370                 "source": "string",
371                 "valid": "VALID",
372                 "message": "string"
373               }
374             }
375           ],
376           "registration_number": "string",
377           "registered_address": {
378             "line1": "string",
379             "line2": "string",
380             "city": "string",
381             "postal_code": "string",
382             "state": "string",
383             "country": "AD"
384           }
385         }
386       ]
387     },
388     "custom_fields": [
389       {
390         "id": "string",
391         "reference": "string",
392         "value": "string",
393         "values": [
394           "string"
395         ],
396         "integration_details": {
397           "payment_gateway_variant": "ADYEN",
398           "id": "string",
399           "reference": "string",
400           "adyen": {
401             "recurring_detail_reference": "string"
402           },
403           "stripe": {
404             "payment_method_id": "string"
405           }
406         }
407       }
408     ],
409     "processing_only": true,
410     "pricing_plan_subscription_selector": {
411       "data": [
412         {
413           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
414           "value": "string"
415         }
416       ],
417       "rules": [
418         {
419           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
420           "type": "EQUALS"
421         }
422       ],
423       "filters": [
424         {
425           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
426           "type": "EQUALS",
427           "value": "string"
428         }
429       ],
430       "fallback": "LATEST"
431     },
432     "linked_integrations": [
433       {
434         "id": "string",
435         "link_details": [
436           {
437             "url": "string",
438             "custom_field_name": "string"
439           }
440         ]
441       }
442     ]
443   },
444   "data_trigger_reference": "string",
445   "alert_data": {
446     "entitlement": {
447       "pricing_plan_subscription_id": "string",
448       "entitlement_value": {
449         "number": "string",
450         "amount": {
451           "quantity": "string",
452           "currency": "AED"
453         }
454       },
455       "threshold_value": {
456         "number": "string",
457         "amount": {
458           "quantity": "string",
459           "currency": "AED"
460         }
461       },
462       "used_value": {
463         "number": "string",
464         "amount": {
465           "quantity": "string",
466           "currency": "AED"
467         }
468       }
469     },
470     "invoice": {
471       "id": "string",
472       "overdue": {
473         "due_date": "2024-01-15T09:30:00Z",
474         "overdue_period": {
475           "type": "DAY",
476           "value": 1
477         }
478       }
479     }
480   }
481 }

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

Request

This endpoint expects an object.

platform_idstringRequired

Resource ID of type PLATFORM

alert_rule_idstringRequired

Resource ID of type ALERT_RULE

customer_idstringRequired

Resource ID of type CUSTOMER

typeenumRequired

Allowed values:

alert_ruleobject or nullOptional

customerobject or nullOptional

data_trigger_referencestring or nullOptional

alert_dataobjectOptional

Response

Created

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

Request

Response

Errors