Notification
An email or a system message sent when a record changes or on a date. A manifest can install one.
Area: The retailer's setup · Why it is here: recipe configure_no_code; recipe customer_code_check; recipe event_feed; recipe post_sale_feedback · Fields: 24
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Notification?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Notification/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one (the required fields first), if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Notification" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"channel": …, "event": …, "document_type": …}'
Change one with PUT /api/resource/Notification/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
s22_customer_loyalty · s48_customer_code_check · s49_post_sale_feedback
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Enabled | enabled |
Check | ||||
| Is Standard | is_standard |
Check | ||||
| Module | module |
Link | Module Def | |||
| Channel | channel |
Select | yes | one of: Email, Slack, System Notification, SMS | ||
| Slack Channel | slack_webhook_url |
Link | Slack Webhook URL | |||
| Subject | subject |
Data | ||||
| Send Alert On | event |
Select | yes | one of: New, Save, Submit, Cancel, Days After, Days Before, Value Change, Method, Custom | ||
| Document Type | document_type |
Link | yes | DocType | ||
| Trigger Method | method |
Data | ||||
| Reference Date | date_changed |
Select | ||||
| Days Before or After | days_in_advance |
Int | ||||
| Value Changed | value_changed |
Select | ||||
| Sender | sender |
Link | Email Account | |||
| Send System Notification | send_system_notification |
Check | ||||
| Sender Email | sender_email |
Data | yes | |||
| Condition | condition |
Code | ||||
| Set Property After Alert | set_property_after_alert |
Select | ||||
| Value To Be Set | property_value |
Data | ||||
| Send To All Assignees | send_to_all_assignees |
Check | ||||
| Recipients | recipients |
Table | Notification Recipient | |||
| Message Type | message_type |
Select | one of: Markdown, HTML, Plain Text | |||
| Message | message |
Code | ||||
| Attach Print | attach_print |
Check | ||||
| Print Format | print_format |
Link | Print Format |
Table: Notification Recipient
The rows of recipients. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Receiver By Document Field | receiver_by_document_field |
Select | ||||
| Receiver By Role | receiver_by_role |
Link | Role | |||
| CC | cc |
Code | ||||
| BCC | bcc |
Code | ||||
| Condition | condition |
Data |