From 1f3d064672b3e64f8cf6bdf5754240e9c1c49539 Mon Sep 17 00:00:00 2001 From: Ife <64481442+ifeoluwafavour@users.noreply.github.com> Date: Tue, 22 Oct 2024 16:29:49 +0100 Subject: [PATCH 1/3] Update index.rst Resolves #216 - documentation for webhook events and payloads --- docs/webhooks/events/index.rst | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/webhooks/events/index.rst b/docs/webhooks/events/index.rst index 00b269a4..009d774b 100644 --- a/docs/webhooks/events/index.rst +++ b/docs/webhooks/events/index.rst @@ -1,20 +1,19 @@ Webhook events and payloads =========================== +Webhook events are specific actions that occur in the system, such as when a Contact is added or when a Form is submitted. When an event occurs, a payload containing data about the event is sent to the registered Webhook URL. -.. toctree:: - :caption: Events - :hidden: +Below is a list of documented events with their event types and the structure of their payloads: - lead_post_save_new - lead_post_save_update - lead_points_change - lead_post_delete - lead_channel_subscription_changed - lead_company_change - company_post_save - company_post_delete - email_on_send - email_on_open - form_on_submit - page_on_hit - sms_on_send \ No newline at end of file +* :ref:`webhooks/events/lead_post_save_new:Contact identified event` +* :ref:`webhooks/events/lead_post_save_update:Contact updated event` +* :ref:`webhooks/events/lead_points_change:Contact Points changed event` +* :ref:`webhooks/events/lead_post_delete:Contact deleted event` +* :ref:`webhooks/events/lead_channel_subscription_changed:Contact Channel subscription change event` +* :ref:`webhooks/events/lead_company_change:Contact Company subscription change event` +* :ref:`webhooks/events/company_post_save:Company created/updated event` +* :ref:`webhooks/events/company_post_delete:Company deleted event` +* :ref:`webhooks/events/email_on_send:Email send event` +* :ref:`webhooks/events/email_on_open:Email open event` +* :ref:`webhooks/events/form_on_submit:Form submit event` +* :ref:`webhooks/events/page_on_hit:Page hit event` +* :ref:`webhooks/events/sms_on_send:Text send event` From 7de9724c2cff912b7cc875525e3db712f63b9a1a Mon Sep 17 00:00:00 2001 From: Ife <64481442+ifeoluwafavour@users.noreply.github.com> Date: Tue, 22 Oct 2024 16:42:28 +0100 Subject: [PATCH 2/3] Update index.rst made grammar changes suggested by Vale --- docs/webhooks/events/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/webhooks/events/index.rst b/docs/webhooks/events/index.rst index 009d774b..2827e6a6 100644 --- a/docs/webhooks/events/index.rst +++ b/docs/webhooks/events/index.rst @@ -1,6 +1,6 @@ Webhook events and payloads =========================== -Webhook events are specific actions that occur in the system, such as when a Contact is added or when a Form is submitted. When an event occurs, a payload containing data about the event is sent to the registered Webhook URL. +Webhook events are specific actions that occur in the system, such as when a Contact creates a new account. When an event occurs, Mautic sends a payload containing data about the event to the registered Webhook URL. Below is a list of documented events with their event types and the structure of their payloads: From def7264959aca2faaa6307224344722bc619e842 Mon Sep 17 00:00:00 2001 From: Ife <64481442+ifeoluwafavour@users.noreply.github.com> Date: Thu, 24 Oct 2024 14:49:09 +0100 Subject: [PATCH 3/3] Add webhook events and payloads to menu - toctree update Updates #223 - I added the events under a toctree --- docs/webhooks/events/index.rst | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/docs/webhooks/events/index.rst b/docs/webhooks/events/index.rst index 2827e6a6..0eb73c0c 100644 --- a/docs/webhooks/events/index.rst +++ b/docs/webhooks/events/index.rst @@ -4,16 +4,21 @@ Webhook events are specific actions that occur in the system, such as when a Con Below is a list of documented events with their event types and the structure of their payloads: -* :ref:`webhooks/events/lead_post_save_new:Contact identified event` -* :ref:`webhooks/events/lead_post_save_update:Contact updated event` -* :ref:`webhooks/events/lead_points_change:Contact Points changed event` -* :ref:`webhooks/events/lead_post_delete:Contact deleted event` -* :ref:`webhooks/events/lead_channel_subscription_changed:Contact Channel subscription change event` -* :ref:`webhooks/events/lead_company_change:Contact Company subscription change event` -* :ref:`webhooks/events/company_post_save:Company created/updated event` -* :ref:`webhooks/events/company_post_delete:Company deleted event` -* :ref:`webhooks/events/email_on_send:Email send event` -* :ref:`webhooks/events/email_on_open:Email open event` -* :ref:`webhooks/events/form_on_submit:Form submit event` -* :ref:`webhooks/events/page_on_hit:Page hit event` -* :ref:`webhooks/events/sms_on_send:Text send event` +.. toctree:: + :caption: Events + :titlesonly: + + lead_post_save_new + lead_post_save_update + lead_points_change + lead_post_delete + lead_channel_subscription_changed + lead_company_change + company_post_save + company_post_delete + email_on_send + email_on_open + form_on_submit + page_on_hit + sms_on_send +