Skip to content
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.

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

Add webhook events and payloads to menu #223

Merged
merged 5 commits into from
Nov 19, 2024
Merged

Conversation

ifeoluwafavour
Copy link
Contributor

Resolves #216 - documentation for webhook events and payloads

Resolves mautic#216 - documentation for webhook events and payloads
made grammar changes suggested by Vale
@RCheesley RCheesley closed this Oct 24, 2024
@RCheesley RCheesley reopened this Oct 24, 2024
Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

Some build errors as the webhook pages aren't on any ToC tree. Please take a look!

Copy link
Member

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

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?

@RCheesley RCheesley changed the title Update index.rst Add webhook events and payloads to menu Oct 24, 2024
Updates mautic#223 - I added the events under a toctree
Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

This looks great @ifeoluwafavour sorry for the delay in getting back to you!

@RCheesley RCheesley merged commit 074bdb3 into mautic:5.x Nov 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write documentation for Webhook events and payloads component
2 participants