Skip to content

Add webhook events and payloads to menu #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 19, 2024
Merged

Add webhook events and payloads to menu #223

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f3d064
Update index.rst
ifeoluwafavour Oct 22, 2024
7de9724
Update index.rst
ifeoluwafavour Oct 22, 2024
656ee9c
Merge branch '5.x' into patch-4
RCheesley Oct 24, 2024
650047c
Merge branch '5.x' into patch-4
RCheesley Oct 24, 2024
def7264
Add webhook events and payloads to menu - toctree update
ifeoluwafavour Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions docs/webhooks/events/index.rst
View file
Open in desktop
Copy link
Member

@RCheesley RCheesley Oct 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ifeoluwafavour when I build the HTML there's a bunch of warnings that these pages do not exist in a ToC tree.

/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/company_post_delete.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/company_post_save.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/email_on_open.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/email_on_send.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/form_on_submit.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/lead_channel_subscription_changed.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/lead_company_change.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/lead_points_change.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/lead_post_delete.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/lead_post_save_new.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/lead_post_save_update.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/page_on_hit.rst: WARNING: document isn't included in any toctree
/Users/rcheesley/Sites/local.newdevdocs/developer-documentation-new/docs/webhooks/events/sms_on_send.rst: WARNING: document isn't included in any toctree
done

Can you please add them, maybe to the root index.rst under the Webhooks section? That way they also come up under the menu when you're clicking through. Thanks!

Copy link
Contributor Author

@ifeoluwafavour ifeoluwafavour Oct 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RCheesley i have just added the toctree. Is the syntax okay?

Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
Webhook events and payloads
===========================
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.

.. 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
* :ref:`webhooks/events/lead_post_save_new:Contact identified event`

Check warning on line 7 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 7, "column": 9}}}, "severity": "INFO"}

Check failure on line 7 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 7, "column": 9}}}, "severity": "ERROR"}
* :ref:`webhooks/events/lead_post_save_update:Contact updated event`

Check warning on line 8 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 8, "column": 9}}}, "severity": "INFO"}

Check failure on line 8 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 8, "column": 9}}}, "severity": "ERROR"}
* :ref:`webhooks/events/lead_points_change:Contact Points changed event`

Check warning on line 9 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 9, "column": 9}}}, "severity": "INFO"}

Check failure on line 9 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 9, "column": 9}}}, "severity": "ERROR"}
* :ref:`webhooks/events/lead_post_delete:Contact deleted event`

Check warning on line 10 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 10, "column": 9}}}, "severity": "INFO"}

Check failure on line 10 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 10, "column": 9}}}, "severity": "ERROR"}
* :ref:`webhooks/events/lead_channel_subscription_changed:Contact Channel subscription change event`

Check warning on line 11 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 11, "column": 9}}}, "severity": "INFO"}

Check failure on line 11 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 11, "column": 9}}}, "severity": "ERROR"}
* :ref:`webhooks/events/lead_company_change:Contact Company subscription change event`

Check warning on line 12 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 12, "column": 9}}}, "severity": "INFO"}

Check failure on line 12 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 12, "column": 9}}}, "severity": "ERROR"}
* :ref:`webhooks/events/company_post_save:Company created/updated event`

Check failure on line 13 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 13, "column": 9}}}, "severity": "ERROR"}

Check warning on line 13 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 13, "column": 9}}}, "severity": "INFO"}
* :ref:`webhooks/events/company_post_delete:Company deleted event`

Check warning on line 14 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 14, "column": 9}}}, "severity": "INFO"}

Check failure on line 14 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 14, "column": 9}}}, "severity": "ERROR"}
* :ref:`webhooks/events/email_on_send:Email send event`

Check warning on line 15 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 15, "column": 9}}}, "severity": "INFO"}

Check failure on line 15 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Vale.Terms] Use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 15, "column": 9}}}, "severity": "ERROR"}
* :ref:`webhooks/events/email_on_open:Email open event`

Check warning on line 16 in docs/webhooks/events/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Webhooks' instead of 'webhooks'.", "location": {"path": "docs/webhooks/events/index.rst", "range": {"start": {"line": 16, "column": 9}}}, "severity": "INFO"}
* :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`
Loading