Webhook Payload Examples

Here’s a list of the events that trigger webhooks within Content Snare, and the payloads in those webhooks. Product Webhooks Product Item Used Product Item Returned Product Item Exhausted Product Item Manual Purchase Product Item Auto Purchase Product Item Purchase Failed Request Webhooks Request Created Request Updated Request Deleted Request Drafted Request Published Request Completed Request Archived Request Viewed Request Create Failed Request Update Failed Request Delete Failed Kanban Column Updated Field Webhooks All Fields Completed Field Completed Field Approved Field Rejected Comment Added 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: Product Item Used Example JSON payload: Product Item Returned Example JSON payload: { "event_name": "product_item_returned", "id": "vss_M1yg0LAfjBg9rD", "quantity": 1, "client_full_name": "1Test", "client_email": "[email protected]", "request_name": "Website Page Information", "product": "identityverification", "request_id": "req_7v80jRXC4M0mAo", "page_id": "pag_k5vqbXLtO5r9YP", "section_id": "sec_36DNbxLI29QbxV", "field_id": "fld_B783LN8u6LaeEq", "account_id": "acc_vK7Zym9U35Z69l", "text": "Credit returned due to client declining license rights" } Product Item Exhausted Example JSON payload: Product Item Manual Purchase Example JSON payload: { "event_name": "product_item_manual_purchase", "id": "pmn_5MlDbWpmhD3rg4", "status": "paid", "account_id": "acc_e7EVAXvJfxZ9zb", "payment_initiator": "customer", "quantity": 10, "invoice": "CS-5734", "product": "identityverification" } Product Item Auto Purchase Example JSON payload: { "event_name": "product_item_auto_purchase", "id": "pmn_5MlDbWpmhD3rg4", "status": "paid", "payment_initiator": "merchant", "quantity": 10, "invoice": "CS-5735", "product": "identityverification" } Product Item Purchase Failed Example JSON payload: { "event_name": "product_item_purchase_failed", "id": "pmn_5MlDbWpmhD3rg4", "status": "not_paid", "account_id": "acc_e7EVAXvJfxZ9zb", "payment_initiator": "customer", "quantity": 10, "product": "identityverification", "error_messages": [ "Failed to activate auto collection on the billing side" ] } Request Created Example JSON payload: Example JSON payload: Request Deleted Example JSON payload: { "event_name": "request_destroyed", "id": 0 } Request Draft Example JSON payload: Request Published Example JSON payload: Request Completed Example JSON payload: { "id": "0", "event_name": "request_completed", "name": "Example Request", "status": "published", "due_date": "2020-10-20", "folder_name": "Default Folder" "url": "https://app.wordpress-69810-4035810.cloudwaysapps.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.wordpress-69810-4035810.cloudwaysapps.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "0", "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": 0, "name": "Example Request", "status": "archived", "due_date": "2020-10-20", "folder_name": "Default Folder", "url": "https://app.wordpress-69810-4035810.cloudwaysapps.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.wordpress-69810-4035810.cloudwaysapps.com/requests/EXAMPLE_ONLY", "share_via_link_enabled": true, "owner_name": "Example Owner", "author_name": "Example Author", "client_status": null, "client": { "id": 0, "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": 0, "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 Viewed Example JSON payload: Request Create Failed Example JSON payload: Example JSON payload: Request Delete Failed Example JSON payload: Example JSON payload: Field Webhooks All Fields Completed Example JSON payload: Field Completed Example JSON payload: { "id": "0", "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: 0, "name: "Example Request", "status: "published", "due_date: "2020-10-20", "folder_name: "Default Folder", "url: "https://app.wordpress-69810-4035810.cloudwaysapps.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.wordpress-69810-4035810.cloudwaysapps.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id: "0", "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": "0", "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": 0, "name": "Example Request", "status": "published", "due_date": "2020-10-20", "folder_name": "Default Folder", "url: "https://app.wordpress-69810-4035810.cloudwaysapps.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.wordpress-69810-4035810.cloudwaysapps.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "0", "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": "0", "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": 0, "name": "Example Request", "status": "published", "due_date": "2020-10-20", "folder_name": "Default Folder", "url: "https://app.wordpress-69810-4035810.cloudwaysapps.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.wordpress-69810-4035810.cloudwaysapps.com/requests/EXAMPLE_ONLY", "owner_name": "Example Owner", "author_name": "Example Author", "client": { "id": "0", "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", } } } 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": "Comment Sample", "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" ] } Example JSON payload: Client Webhooks Client Created Example JSON payload: Example JSON payload: Client Deleted Example JSON payload: { "event_name": "client_destroyed", "id": 0 } 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": 0, "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" ] } Example JSON payload: { "event_name": "client_update_failed", "id": 0, "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": 0, "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": 0, "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": 0, "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: Example JSON payload: Team Member Deleted Example JSON payload: { "event_name": "team_member_destroyed", "id": 0 } Team Member Create Failed Example JSON payload: Example JSON payload: { "event_name": "team_member_update_failed", "id": 0, "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": 0, "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" ] } SMS Message Delivered Example JSON payload: SMS Message Failed Example JSON payload: { "event_name": "sms_failed", "id": "evt_kGJLLVU39RNJ58", "request_id": "req_EazYy1Uj4n9zqG", "account_id": "acc_3Z02jLuqYAN0eX", "event_type": "critical", "parameters": { "from": "+14159039621", "email": "+61123456789", "status": "sms_failed", "subject": "Test", "error_messages": [ "Permission to send an SMS has not been enabled for the region indicated by the 'To' number: +6112345XXXX" ] }, "client": { "id": "acc_3Z02jLuqYAN0eX", "full_name": "Example Client", "email": "[email protected]", "timezone": "Asia/Manila", "avatar": null, "company_name": "", "date_format": "MM/dd/yyyy", "language_code": "en", "client_company": null }, "request": { "id": "req_EazYy1Uj4n9zqG", "name": "Example Request", "url": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "status": "published", "due": "2024-04-29", "folder_name": "Default Folder", "passcode_enabled": false, "share_link": "https://app.contentsnare.com/requests/EXAMPLE_ONLY", "share_via_link_enabled": true, "communications_template_name": "Default", "completion_percentage": 0, "comments_enabled": true, "request_template_name": "Example Template", "owner_name": "Example Owner", "author_name": "Example Author", "client_status": null, "due_date": "2024-04-29", "pin_code_enabled": false } } Email Message Delivered Example JSON payload: Email Message Bounced Example JSON payload: Email Message Spammed Example JSON payload: 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”:

Still puzzling over something?