Of course! For those of you interested, firstly, here’s a list of the events that trigger webhooks within Content Snare:
Request Webhooks
- Request Created
- Request Updated
- Request Deleted
- Request Published
- Request Completed
- Request Archived
- Request Create Failed
- Request Update Failed
- Request Delete Failed
- Kanban Column Updated
- Request Viewed – client accessed the request via their link
- Request Draft – request switched back to draft from another state
Field Webhooks
- All Fields Completed
- Field Completed
- Field Approved
- Field Rejected
- Comment Added
- Comment Create Failed
Client Webhooks
- Client Created
- Client Updated
- Client Deleted
- Client Create Failed
- Client Update Failed
- Client Delete Failed
Team Member Webhooks
- Team Member Created
- Team Member Updated
- Team Member Deleted
- Team Member Create Failed
- Team Member Update Failed
- Team Member Delete Failed
Communication Webhooks
- SMS Message Delivered
- SMS Message Failed
- Email Message Delivered
- Email Message Bounced
- Email Message Spammed
For each webhook, there is a specific JSON (JavaScript Object Notation) payload. These are as follows:
Request Created
Example JSON payload:
{ "id": "req_1k7zv4aUlpN8PB", "event_name": "request_created", "name": "Example Request", "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "status": "draft", "due_date": "2020-10-20", "folder_name": "Default Folder", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": "0", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", } }
Request Updated
Example JSON payload:
{ "event_name": "request_updated", "id": "req_1k7zv4aUlpN8PB" , "name": "Example Request", "status": "draft", "due_date": "2020-10-20", "folder_name": "Default Folder", "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": true, "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": 0, "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "share_via_link_enabled": true, "owner_name": "Example Owner", "author_name": "Example Author", "client_status": null, "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" }, "clients": [ { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" } ] }
Request Deleted
Example JSON payload:
{ "event_name": "request_destroyed", "id": "req_1k7zv4aUlpN8PB" }
Request Published
Example JSON payload:
{ "id": "req_1k7zv4aUlpN8PB", "event_name": "request_published", "name": "Example Request", "status": "published", "due_date": "2020-10-20", "folder_name": "Default Folder" "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": "true", "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": "0", "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", } }
Request Completed
Example JSON payload:
{ "id": "req_1k7zv4aUlpN8PB", "event_name": "request_completed", "name": "Example Request", "status": "published", "due_date": "2020-10-20", "folder_name": "Default Folder" "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": "true", "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": "0", "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", }, pages: [{ name: "Example Page 1", instruction_text: "Example Page 1 Instructions", sections: [{ name: "Example Section 1", instruction_text: "Example Section 1 Instructions", fields: [{ name: "Example Field 1", instruction_text: "Example Field 1 Instructions", type: "text", status: "approved", values: [], values_flat: "" }], fields_count: 1 }], fields_count: 1 }] }
Request Archived
Example JSON payload:
{ "event_name": "request_archived", "id": "req_1k7zv4aUlpN8PB", "name": "Example Request", "status": "archived", "due_date": "2020-10-20", "folder_name": "Default Folder", "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": true, "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": 0, "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "share_via_link_enabled": true, "owner_name": "Example Owner", "author_name": "Example Author", "client_status": null, "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" }, "clients": [ { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" } ], "pages": [ { "toc_order_label": "1.0", "name": "Example Page 1", "instruction_text": "Example Page 1 Instructions", "sections": [ { "toc_order_label": "1.1", "name": "Example Section 1", "instruction_text": "Example Section 1 Instructions", "fields": [ { "name": "Example Field 1", "instruction_text": "Example Field 1 Instructions", "type": "text", "status": "approved", "values": [], "values_flat": "" } ], "fields_count": 1 } ], "fields_count": 1 } ] }
Request Create Failed
Example JSON payload:
{ "event_name": "request_create_failed", "id": null, "name": "Example Request", "status": "draft", "due_date": "2020-10-20", "folder_name": "Default Folder", "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": true, "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": 0, "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "share_via_link_enabled": true, "owner_name": "Example Owner", "author_name": "Example Author", "client_status": null, "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" }, "clients": [ { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" } ], "errors": [ "First error message example", "Second error message example" ] }
Request Update Failed
Example JSON payload:
{ "event_name": "request_update_failed", "id": "req_1k7zv4aUlpN8PB", "name": "Example Request", "status": "draft", "due_date": "2020-10-20", "folder_name": "Default Folder", "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": true, "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": 0, "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "share_via_link_enabled": true, "owner_name": "Example Owner", "author_name": "Example Author", "client_status": null, "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" }, "clients": [ { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" } ], "errors": [ "First error message example", "Second error message example" ] }
Request Delete Failed
Example JSON payload:
{ "event_name": "request_destroy_failed", "id": "req_1k7zv4aUlpN8PB", "name": "Example Request", "status": "draft", "due_date": "2020-10-20", "folder_name": "Default Folder", "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": true, "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": 0, "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "share_via_link_enabled": true, "owner_name": "Example Owner", "author_name": "Example Author", "client_status": null, "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" }, "clients": [ { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" } ], "errors": [ "First error message example", "Second error message example" ] }
Kanban Column Updated
Example JSON payload:
{ "event_name": "request_board_column_changed", "id": "req_1k7zv4aUlpN8PB", "name": "Example Request", "status": "draft", "due_date": "2020-10-20", "folder_name": "Default Folder", "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": true, "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": 0, "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "share_via_link_enabled": true, "owner_name": "Example Owner", "author_name": "Example Author", "client_status": null, "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" }, "clients": [ { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash" } ], "board_column": { "id": "bcl_K0fAw9Cyq10Unq", "name": "Kanban Column Name", "sorting_position": 0 } }
Request Viewed
Example JSON payload:
{
"event_name": "request_viewed",
"id": "evt_4Dv6gV1cZb48la",
"request_id": "req_AkZDXXKHY6DYrX",
"account_id": "acc_ayGZxmdUy2RDpP",
"event_type": "actions",
"parameters": {
"name": "Example Request"
},
"request": {
"id": "req_1k7zv4aUlpN8PB",
"name": "Example Request",
"status": "draft",
"due": "2020-10-20",
"folder_name": "Default Folder",
"url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"passcode_enabled": true,
"request_template_name": "Example Template",
"communications_template_name": "Default",
"completion_percentage": 0,
"share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"share_via_link_enabled": true,
"owner_name": "Example Owner",
"author_name": "Example Author"
},
"client": {
"id": "acc_e7EVAXvJfxZ9zb",
"date_format": "MM/dd/yyyy",
"email": "[email protected]",
"full_name": "Sample Client",
"language_code": "en",
"phone": "987-654-3210",
"timezone": "Australia/Brisbane",
"avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash"
}
}
Request Draft
Example JSON payload:
{
"event_name": "request_draft",
"id": "req_GoDQXKHAYaxlrq",
"name": "Property Management Questionnaire",
"url": "https://abcdefgh.contentsnare.com/requests/333599",
"status": "published",
"due": "2024-02-20",
"folder_name": "Default Folder",
"passcode_enabled": false,
"share_link": "https://abcdefgh.contentsnare.com/shared/3bbaf948-14e4-4453-b887-aaee5eba8901",
"share_via_link_enabled": true,
"communications_template_name": "None",
"completion_percentage": 0,
"comments_enabled": false,
"request_template_name": "Property Management Questionnaire",
"owner_name": "Drazen Vujovic",
"author_name": "Drazen Vujovic",
"client_status": null,
"due_date": "2024-02-20",
"pin_code_enabled": false,
"client": {
"id": "acc_3VgAPdH5enW0G4",
"email": "[email protected]",
"full_name": "Drazen Vujovic",
"phone": "",
"avatar": null,
"company_name": null,
"url": "https://abcdefgh.contentsnare.com/shared/3bbaf948-14e4-4453-b887-aaee5eba8901"
},
"clients": [
{
"id": "acc_3VgAPdH5enW0G4",
"email": "[email protected]",
"full_name": "Drazen Vujovic",
"phone": "",
"avatar": null,
"company_name": null,
"url": "https://abcdefgh.contentsnare.com/shared/3bbaf948-14e4-4453-b887-aaee5eba8901"
}
]
}
Field Webhooks
All Fields Completed
Example JSON payload:
{ "event_name": "all_fields_completed", "request": { "id": "req_1k7zv4aUlpN8PB", "name": "Example Request", "status": "published", "due_date": "2020-10-20", "folder_name": "Default Folder" "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": "true", "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": "0", "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", } } }
Field Completed
Example JSON payload:
{ "id": "fld_1lqbwY6TaMPmAo", "event_name": "field_completed", "section_id": "0", "section_name": "Example section name", "page_id": "0", "page_name": "Example page name", "name": "Example completed field name", "instruction_text": "Example completed field instructions", "status: "done", "type: "text", "values: ["Example completed field answer"], "values_flat: "Example approved field answer", "request: { "id: "req_1k7zv4aUlpN8PB", "name: "Example Request", "status: "published", "due_date: "2020-10-20", "folder_name: "Default Folder", "url: "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": "true", "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": "0", "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id: "acc_MORVw9Cyq97AyN", "company_name: "Example Company", "email: "[email protected]", "full_name: 'Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", } } }
Field Approved
Example JSON payload:
{ "id": "fld_1lqbwY6TaMPmAo", "event_name": "field_approved", "section_id": "0", "section_name": "Example section name", "page_id": "0", "page_name: "Example page name", "name": 'Example approved field name', "instruction_text": "Example approved field instructions", "status": "approved", "type": "text", "values": ["Example approved field answer"], "values_flat": "Example approved field answer", "request": { "id": "req_1k7zv4aUlpN8PB", "name": "Example Request", "status": "published", "due_date": "2020-10-20", "folder_name": "Default Folder", "url: "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": "true", "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": "0", "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", } } }
Field Rejected
Example JSON payload:
{ "id": "fld_1lqbwY6TaMPmAo", "event_name": "field_rejected", "section_id": "0", "section_name": "Example section name", "page_id": "0", "page_name: "Example page name", "name": 'Example approved field name', "instruction_text": "Example approved field instructions", "status": "approved", "type": "text", "values": ["Example approved field answer"], "values_flat": "Example approved field answer", "request": { "id": "req_1k7zv4aUlpN8PB" , "name": "Example Request", "status": "published", "due_date": "2020-10-20", "folder_name": "Default Folder", "url: "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "pin_code_enabled": "true", "pin_code": "1234", "request_template_name": "Example Template", "communications_template_name": "Default", "completion_percentage": "0", "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "acc_MORVw9Cyq97AyN", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", } } }
Comment Added
Example JSON payload:
{ "event_name": "comment_created", "id": "com_n77Ew9i0q90NeR", "answer_id": 0, "field_id": 0, "section_id": 0, "tab_id": 0, "request_id": 0, "text": "<div>Comment Sample</div>", "type": "user", "unread": false, "reference_meta": {}, "account": { "id": "acc_MORVw9Cyq97AyN" , "full_name": "Example Client", "email": "[email protected]", "timezone": "Australia/Brisbane", "primary": true, "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "company_name": "New company", "date_format": "MM/dd/yyyy", "language_code": "en", "client_company": { "id": "com_n77Ew9i0q90NeR", "name": "New company", "avatar_url": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "external_source": null } } }
Comment Create Failed
Example JSON payload:
{
"event_name": "comment_created",
"id": null,
"answer_id": "ans_RQ1zp49c7Xz4km",
"field_id": "fld_1lqbwY6TaMPmAo",
"section_id": "sec_YlVGMK1svdga0D",
"tab_id": "pag_jAxqEgBi4prM6g",
"request_id": "req_1k7zv4aUlpN8PB",
"text": "<div>Comment Sample</div>",
"type": "user",
"unread": false,
"reference_meta": {},
"account": {
"id": "acc_e7EVAXvJfxZ9zb",
"full_name": "Example Client",
"email": "[email protected]",
"timezone": "Australia/Brisbane",
"primary": true,
"avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash",
"company_name": "New company",
"date_format": "MM/dd/yyyy",
"language_code": "en",
"client_company": {
"id": "cmp_z105QJxhy7YdlX",
"name": "New company",
"avatar_url": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash"
}
},
"errors": [
"First error message example",
"Second error message example"
]
}
Client Webhooks
Client Created
Example JSON payload:
{ "id": "acc_MORVw9Cyq97AyN" , "event_name": "client_created", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", }
Client Updated
Example JSON payload:
{ "id": "acc_MORVw9Cyq97AyN", "event_name": "client_updated", "company_name": "Example Company", "email": "[email protected]", "full_name": "Example Client", "phone": "123-456-7890", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", }
Client Deleted
Example JSON payload:
{ "event_name": "client_destroyed", "id": "acc_MORVw9Cyq97AyN" }
Client Create Failed
Example JSON payload:
{ "event_name": "client_create_failed", "id": null, "date_format": "MM/dd/yyyy", "email": "[email protected]", "full_name": "Sample Client", "language_code": "en", "phone": "987-654-3210", "timezone": "Australia/Brisbane", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "archived": false, "is_assigned": false, "client_companies": [ { "id": "cmp_z105QJxhy7YdlX", "name": "Example Client", "avatar_url": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "external_source": null } ], "errors": [ "First error message example", "Second error message example" ] }
Client Update Failed
Example JSON payload:
{ "event_name": "client_update_failed", "id": "acc_MORVw9Cyq97AyN", "date_format": "MM/dd/yyyy", "email": "[email protected]", "full_name": "Sample Client", "language_code": "en", "phone": "987-654-3210", "timezone": "Australia/Brisbane", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "archived": false, "is_assigned": false, "client_companies": [ { "id": "cmp_z105QJxhy7YdlX", "name": "Example Client", "avatar_url": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "external_source": null } ], "errors": [ "First error message example", "Second error message example" ] }
Client Delete Failed
Example JSON payload:
{ "event_name": "client_destroy_failed", "id": "acc_MORVw9Cyq97AyN", "date_format": "MM/dd/yyyy", "email": "[email protected]", "full_name": "Sample Client", "language_code": "en", "phone": "987-654-3210", "timezone": "Australia/Brisbane", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "archived": false, "is_assigned": false, "client_companies": [ { "id": "cmp_z105QJxhy7YdlX", "name": "Example Client", "avatar_url": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "external_source": null } ], "errors": [ "First error message example", "Second error message example" ] }
Team Member Webhooks
Team Member Created
Example JSON payload:
{ "event_name": "team_member_created", "id": "acc_e7EVAXvJfxZ9zb", "date_format": "dd/MM/yyyy", "email": "[email protected]", "full_name": "Sample Client", "language_code": "en", "phone": null, "timezone": "Europe/Budapest", "avatar": "https://www.gravatar.com/avatar/796a5b4cada85b3a3716467b77dc717b?s=100&d=mp" }
Team Member Updated
Example JSON payload:
{ "event_name": "team_member_updated", "id": "acc_e7EVAXvJfxZ9zb", "date_format": "dd/MM/yyyy", "email": "[email protected]", "full_name": "Sample Client", "language_code": "en", "phone": null, "timezone": "Europe/Budapest", "avatar": "https://www.gravatar.com/avatar/796a5b4cada85b3a3716467b77dc717b?s=100&d=mp" }
Team Member Deleted
Example JSON payload:
{ "event_name": "team_member_destroyed", "id": "acc_e7EVAXvJfxZ9zb" }
Team Member Create Failed
Example JSON payload:
{ "event_name": "team_member_create_failed", "id": null, "date_format": "MM/dd/yyyy", "email": "[email protected]", "full_name": "Sample Client", "language_code": "en", "phone": "987-654-3210", "timezone": "Australia/Brisbane", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "errors": [
Team Member Update Failed
Example JSON payload:
{ "event_name": "team_member_update_failed", "id": "acc_e7EVAXvJfxZ9zb", "date_format": "MM/dd/yyyy", "email": "[email protected]", "full_name": "Sample Client", "language_code": "en", "phone": "987-654-3210", "timezone": "Australia/Brisbane", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "errors": [ "First error message example", "Second error message example" ] }
Team Member Delete Failed
Example JSON payload:
{ "event_name": "team_member_destroy_failed", "id": "acc_e7EVAXvJfxZ9zb", "date_format": "MM/dd/yyyy", "email": "[email protected]", "full_name": "Sample Client", "language_code": "en", "phone": "987-654-3210", "timezone": "Australia/Brisbane", "avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash", "errors": [ "First error message example", "Second error message example" ] }
Communication Webhooks
SMS Message Delivered
Example JSON payload:
{
"event_name": "sms_delivered",
"id": "evt_J5z6w2Vc20p8MA",
"request_id": "req_AkZDXXKHY6DYrX",
"account_id": "acc_ayGZxmdUy2RDpP",
"event_type": "actions",
"parameters": {
"from": "+10000000000",
"phone": "+10000000000",
"status": "sms_delivered",
"subject": "Test Message",
"template_name": "SMS Test Template"
},
"request": {
"id": "req_1k7zv4aUlpN8PB",
"name": "Example Request",
"status": "draft",
"due": "2020-10-20",
"folder_name": "Default Folder",
"url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"passcode_enabled": true,
"request_template_name": "Example Template",
"communications_template_name": "Default",
"completion_percentage": 0,
"share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"share_via_link_enabled": true,
"owner_name": "Example Owner",
"author_name": "Example Author"
},
"client": {
"id": "acc_e7EVAXvJfxZ9zb",
"date_format": "MM/dd/yyyy",
"email": "[email protected]",
"full_name": "Sample Client",
"language_code": "en",
"phone": "987-654-3210",
"timezone": "Australia/Brisbane",
"avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash"
}
}
SMS Message Failed
Example JSON payload:
{
"event_name": "sms_failed",
"id": "evt_Q196zzGsR0G6DZ",
"request_id": "req_AkZDXXKHY6DYrX",
"account_id": "acc_ayGZxmdUy2RDpP",
"event_type": "critical",
"parameters": {
"from": "+10000000000",
"phone": "+10000000000",
"status": "sms_failed",
"subject": "Test Message",
"template_name": "SMS Test Template",
"error_messages": [
"SMS failed error message"
]
},
"request": {
"id": "req_1k7zv4aUlpN8PB",
"name": "Example Request",
"status": "draft",
"due": "2020-10-20",
"folder_name": "Default Folder",
"url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"passcode_enabled": true,
"request_template_name": "Example Template",
"communications_template_name": "Default",
"completion_percentage": 0,
"share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"share_via_link_enabled": true,
"owner_name": "Example Owner",
"author_name": "Example Author"
},
"client": {
"id": "acc_e7EVAXvJfxZ9zb",
"date_format": "MM/dd/yyyy",
"email": "[email protected]",
"full_name": "Sample Client",
"language_code": "en",
"phone": "987-654-3210",
"timezone": "Australia/Brisbane",
"avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash"
}
}
Email Message Delivered
Example JSON payload:
{
"event_name": "email_delivered",
"id": "evt_9xR85rZcRDG6gA",
"request_id": "req_AkZDXXKHY6DYrX",
"account_id": "acc_ayGZxmdUy2RDpP",
"event_type": "actions",
"parameters": {
"from": "333 <[email protected]>",
"email": "[email protected]",
"status": "email_delivered",
"subject": "Test Subject"
},
"request": {
"id": "req_1k7zv4aUlpN8PB",
"name": "Example Request",
"status": "draft",
"due": "2020-10-20",
"folder_name": "Default Folder",
"url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"passcode_enabled": true,
"request_template_name": "Example Template",
"communications_template_name": "Default",
"completion_percentage": 0,
"share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"share_via_link_enabled": true,
"owner_name": "Example Owner",
"author_name": "Example Author"
},
"client": {
"id": "acc_e7EVAXvJfxZ9zb",
"date_format": "MM/dd/yyyy",
"email": "[email protected]",
"full_name": "Sample Client",
"language_code": "en",
"phone": "987-654-3210",
"timezone": "Australia/Brisbane",
"avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash"
}
}
Email Message Bounced
Example JSON payload:
{
"event_name": "email_bounced",
"id": "evt_ajEOKwmFYv2OJv",
"request_id": "req_AkZDXXKHY6DYrX",
"account_id": "acc_ayGZxmdUy2RDpP",
"event_type": "critical",
"parameters": {
"from": "[email protected]",
"email": "[email protected]",
"status": "email_bounced",
"subject": "Test Subject",
"error_messages": [
"The server was unable to deliver your message (ex: unknown user, mailbox not found)."
]
},
"request": {
"id": "req_1k7zv4aUlpN8PB",
"name": "Example Request",
"status": "draft",
"due": "2020-10-20",
"folder_name": "Default Folder",
"url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"passcode_enabled": true,
"request_template_name": "Example Template",
"communications_template_name": "Default",
"completion_percentage": 0,
"share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"share_via_link_enabled": true,
"owner_name": "Example Owner",
"author_name": "Example Author"
},
"client": {
"id": "acc_e7EVAXvJfxZ9zb",
"date_format": "MM/dd/yyyy",
"email": "[email protected]",
"full_name": "Sample Client",
"language_code": "en",
"phone": "987-654-3210",
"timezone": "Australia/Brisbane",
"avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash"
}
}
Email Message Spammed
Exampled JSON payload:
{
"event_name": "email_spam_complained",
"id": "evt_kdW6DV1cYMGOmp",
"request_id": "req_AkZDXXKHY6DYrX",
"account_id": "acc_ayGZxmdUy2RDpP",
"event_type": "warning",
"parameters": {
"from": "[email protected]",
"email": "[email protected]",
"status": "email_spam_complained",
"subject": "Test Subject",
"error_messages": [
"The subscriber explicitly marked this message as spam."
]
},
"request": {
"id": "req_1k7zv4aUlpN8PB",
"name": "Example Request",
"status": "draft",
"due": "2020-10-20",
"folder_name": "Default Folder",
"url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"passcode_enabled": true,
"request_template_name": "Example Template",
"communications_template_name": "Default",
"completion_percentage": 0,
"share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY",
"share_via_link_enabled": true,
"owner_name": "Example Owner",
"author_name": "Example Author"
},
"client": {
"id": "acc_e7EVAXvJfxZ9zb",
"date_format": "MM/dd/yyyy",
"email": "[email protected]",
"full_name": "Sample Client",
"language_code": "en",
"phone": "987-654-3210",
"timezone": "Australia/Brisbane",
"avatar": "https://www.gravatar.com/avatar/93942e96f5acd83e2e047ad8fe03114d?s=100&d=robohash"
}
}
Field Types
In the above webhooks where a field is involved, there is a “type” parameter included. These are the possible values for field “type”:
- text – text field that accepts a single line of unformatted text.
- textarea – text field that accepts multiple lines of unformatted text.
- wysiwyg – text field that accepts multiple lines of formatted text.
- email – text field that accepts a properly formatted email address.
- url – text field that accepts a properly formatted url.
- number – number field that accepts any positive or negative real or integer number.
- phone – number field that accepts a properly formatted phone number.
- date/time – number field that accepts a properly formatted date.
- image – file field that accepts an image file.
- file – file field that accepts any file type.
- checkbox – option field that shows each option as a checkbox and allows selection of multiple options.
- radio – option field that shows each option as a radio button and allows selection of a single option.
- select – option field that shows each option as a dropdown and allows selection of a single option.
- image select – option field that shows a list of images and allows selection of one image.
- color picker – custom field that allows a color to be selected.