reference
Notification Templates
3 endpoints
GET/api/v3/notification-template/{accountUUID}/templates
List Notification Templates
Requires: ACCOUNT_notification_templates
The account's custom templates. A type without one is sent with the wxrks default text.
path parameters
accountUUIDrequired |
string (uuid) |
query parameters
includeVariants |
booleanAlso list the named variants, each with its variant. |
Responses
200 OK
accountUuid |
string (uuid) |
actionLabel |
string |
body |
string |
footer |
string |
heading |
string |
id |
integer (int64) |
logoAlign |
string |
logoSize |
string |
title |
string |
type |
stringTASK_ASSIGNED_NOT_READY TASK_ASSIGNED_READY TASK_PENDING_ACCEPTANCE TASK_PENDING_ACCEPTANCE_REJECTED TASK_HOURS_AWAITING_APPROVAL TASK_HOURS_REJECTED TASK_READY TASK_SKIPPED TASK_REMINDER TASK_INSTRUCTIONS_UPDATED TASK_STATUS_CHANGED TASK_SOURCE_UPDATED TASK_SOURCE_UPDATE_RELEASED SOURCE_UPDATE_ASSIGNEE_NOT_KEPT CONSOLIDATED_ALLOCATION CONSOLIDATED_PENDING_ACCEPTANCE AUTO_TASK_PLACEMENT_BULK_ASSIGNED CREATE_PASSWORD RESET_PASSWORD PASSWORD_CHANGED PROJECT_STATUS_UPDATE PROJECT_ASSIGNED PROJECT_DELIVERED AUTO_TASK_PLACEMENT_AVAILABLE_TASKS NEW_MESSAGE_NOTIFICATION MESSAGE_MENTION PAYABLE_CREATED PAYABLE_PAID PAYABLE_FAILED_ADMIN PAYABLE_FAILED_VENDOR RECEIVABLE_CREATED MAGIC_LINK MAGIC_CODE WORK_PACKAGE_SENT WORK_PACKAGE_DELIVERED HANDSHAKE_INVITED HANDSHAKE_ACCEPTED ACCOUNT_INVITE_EXISTING_USER ACCOUNT_INVITE_NEW_ACCOUNT ACCOUNT_MIGRATION_INVITE PIPELINE_LOOP_STOPPED |
variant |
string |
Request
curl -X GET 'https://app.wxrks.com/api/v3/notification-template/{accountUUID}/templates' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
Response 200
[
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"actionLabel": "string",
"body": "string",
"footer": "string",
"heading": "string",
"id": 0,
"logoAlign": "string",
"logoSize": "string",
"title": "string",
"type": "TASK_ASSIGNED_NOT_READY",
"variant": "string"
}
]
DELETE/api/v3/notification-template/{accountUUID}/templates/{type}
Reset Notification Template
Requires: ACCOUNT_notification_templates
Removes the account's template of the type, so the email goes with the wxrks default text again. With a variant, removes only that variant.
path parameters
accountUUIDrequired |
string (uuid) |
typerequired |
stringTASK_ASSIGNED_NOT_READY TASK_ASSIGNED_READY TASK_PENDING_ACCEPTANCE TASK_PENDING_ACCEPTANCE_REJECTED TASK_HOURS_AWAITING_APPROVAL TASK_HOURS_REJECTED TASK_READY TASK_SKIPPED TASK_REMINDER TASK_INSTRUCTIONS_UPDATED TASK_STATUS_CHANGED TASK_SOURCE_UPDATED TASK_SOURCE_UPDATE_RELEASED SOURCE_UPDATE_ASSIGNEE_NOT_KEPT CONSOLIDATED_ALLOCATION CONSOLIDATED_PENDING_ACCEPTANCE AUTO_TASK_PLACEMENT_BULK_ASSIGNED CREATE_PASSWORD RESET_PASSWORD PASSWORD_CHANGED PROJECT_STATUS_UPDATE PROJECT_ASSIGNED PROJECT_DELIVERED AUTO_TASK_PLACEMENT_AVAILABLE_TASKS NEW_MESSAGE_NOTIFICATION MESSAGE_MENTION PAYABLE_CREATED PAYABLE_PAID PAYABLE_FAILED_ADMIN PAYABLE_FAILED_VENDOR RECEIVABLE_CREATED MAGIC_LINK MAGIC_CODE WORK_PACKAGE_SENT WORK_PACKAGE_DELIVERED HANDSHAKE_INVITED HANDSHAKE_ACCEPTED ACCOUNT_INVITE_EXISTING_USER ACCOUNT_INVITE_NEW_ACCOUNT ACCOUNT_MIGRATION_INVITE PIPELINE_LOOP_STOPPED |
query parameters
variant |
stringThe variant to remove. Without it, the default template of the type is reset. |
Responses
200 OK
Request
curl -X DELETE 'https://app.wxrks.com/api/v3/notification-template/{accountUUID}/templates/{type}' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN"
POST/api/v3/notification-template/{accountUUID}/update-template
Save Notification Template
Requires: ACCOUNT_notification_templates
Creates or replaces the account's template of one email type. With a variant, it saves a named variant of the type instead, which a send can pick by name (see notifyTaskAssignee); the default template of the type is left as it is. Variants exist for the assignment emails: TASK_ASSIGNED_READY, TASK_ASSIGNED_NOT_READY, TASK_READY, TASK_SKIPPED and TASK_PENDING_ACCEPTANCE.
An account manages only its own templates.
path parameters
accountUUIDrequired |
string (uuid) |
Request body
actionLabel |
string |
bodyrequired |
stringThe email message, in HTML. |
footer |
string |
heading |
string |
logoAlign |
stringleft center right |
logoSize |
stringsmall medium large |
titlerequired |
stringThe email subject. |
typerequired |
stringTASK_ASSIGNED_NOT_READY TASK_ASSIGNED_READY TASK_PENDING_ACCEPTANCE TASK_PENDING_ACCEPTANCE_REJECTED TASK_HOURS_AWAITING_APPROVAL TASK_HOURS_REJECTED TASK_READY TASK_SKIPPED TASK_REMINDER TASK_INSTRUCTIONS_UPDATED TASK_STATUS_CHANGED TASK_SOURCE_UPDATED TASK_SOURCE_UPDATE_RELEASED SOURCE_UPDATE_ASSIGNEE_NOT_KEPT CONSOLIDATED_ALLOCATION CONSOLIDATED_PENDING_ACCEPTANCE AUTO_TASK_PLACEMENT_BULK_ASSIGNED CREATE_PASSWORD RESET_PASSWORD PASSWORD_CHANGED PROJECT_STATUS_UPDATE PROJECT_ASSIGNED PROJECT_DELIVERED AUTO_TASK_PLACEMENT_AVAILABLE_TASKS NEW_MESSAGE_NOTIFICATION MESSAGE_MENTION PAYABLE_CREATED PAYABLE_PAID PAYABLE_FAILED_ADMIN PAYABLE_FAILED_VENDOR RECEIVABLE_CREATED MAGIC_LINK MAGIC_CODE WORK_PACKAGE_SENT WORK_PACKAGE_DELIVERED HANDSHAKE_INVITED HANDSHAKE_ACCEPTED ACCOUNT_INVITE_EXISTING_USER ACCOUNT_INVITE_NEW_ACCOUNT ACCOUNT_MIGRATION_INVITE PIPELINE_LOOP_STOPPED |
variant |
stringName of a variant of the template, for TASK_ASSIGNED_READY, TASK_ASSIGNED_NOT_READY, TASK_READY, TASK_SKIPPED and TASK_PENDING_ACCEPTANCE only: 1 to 64 letters, digits, - or _. Without it, the call saves the account's default template of the type. |
Responses
200 OK
accountUuid |
string (uuid) |
actionLabel |
string |
body |
string |
footer |
string |
heading |
string |
id |
integer (int64) |
logoAlign |
string |
logoSize |
string |
title |
string |
type |
stringTASK_ASSIGNED_NOT_READY TASK_ASSIGNED_READY TASK_PENDING_ACCEPTANCE TASK_PENDING_ACCEPTANCE_REJECTED TASK_HOURS_AWAITING_APPROVAL TASK_HOURS_REJECTED TASK_READY TASK_SKIPPED TASK_REMINDER TASK_INSTRUCTIONS_UPDATED TASK_STATUS_CHANGED TASK_SOURCE_UPDATED TASK_SOURCE_UPDATE_RELEASED SOURCE_UPDATE_ASSIGNEE_NOT_KEPT CONSOLIDATED_ALLOCATION CONSOLIDATED_PENDING_ACCEPTANCE AUTO_TASK_PLACEMENT_BULK_ASSIGNED CREATE_PASSWORD RESET_PASSWORD PASSWORD_CHANGED PROJECT_STATUS_UPDATE PROJECT_ASSIGNED PROJECT_DELIVERED AUTO_TASK_PLACEMENT_AVAILABLE_TASKS NEW_MESSAGE_NOTIFICATION MESSAGE_MENTION PAYABLE_CREATED PAYABLE_PAID PAYABLE_FAILED_ADMIN PAYABLE_FAILED_VENDOR RECEIVABLE_CREATED MAGIC_LINK MAGIC_CODE WORK_PACKAGE_SENT WORK_PACKAGE_DELIVERED HANDSHAKE_INVITED HANDSHAKE_ACCEPTED ACCOUNT_INVITE_EXISTING_USER ACCOUNT_INVITE_NEW_ACCOUNT ACCOUNT_MIGRATION_INVITE PIPELINE_LOOP_STOPPED |
variant |
string |
Request
curl -X POST 'https://app.wxrks.com/api/v3/notification-template/{accountUUID}/update-template' \
-H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"body": "<p>Hello VENDOR_NAME, this task is due TASK_DUE_DATE.</p>",
"title": "New task: PROJECT_NAME",
"type": "TASK_ASSIGNED_READY",
"variant": "urgent"
}'
Response 200
{
"accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"actionLabel": "string",
"body": "string",
"footer": "string",
"heading": "string",
"id": 0,
"logoAlign": "string",
"logoSize": "string",
"title": "string",
"type": "TASK_ASSIGNED_NOT_READY",
"variant": "string"
}