Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/zerver/webhooks/wordpress/doc.md

2.7 KiB
Raw Blame History

See WordPress.com blog notifications in Zulip!

Support for self-installed blogs using software from WordPress.org and the HookPress plugin is experimental. For more details on the two, please see the WordPress support page about the difference between WordPress.com and WordPress.org.

Some actions are only available for self-installed blogs. For a complete list of supported action types, please scroll to the bottom of this page.

{!create-stream.md!}

{!create-bot-construct-url.md!}

{!append-topic.md!}

Important: the HookPress plugin requires URL parameters to be delimited by semicolons instead of ampersands. If you have a self-installed blog, separate parameters with ; instead of &.

Configuration

To configure a new webhook from WordPress, go to the Webhooks page in the Settings section of your blog dashboard and click Add webhook.

If you have trouble locating the correct page on WordPress.com, you can reach it by manually typing the URL in your browser address bar as in this example:

https://yourblogname.wordpress.com/wp-admin/options-general.php?page=webhooks

Select the hook type action and the specific action that should trigger this webhook notification. This example uses publish_post, which is triggered when a new blog post is created.

The Zulip WordPress integration uses the fields post_title, post_type, and post_url for a publish_post action, so select those three fields in the list.

Next, for a WordPress.com blog, enter the URL created above for the Zulip endpoint, making sure that the parameters in the URL are delimited by &.

For a self-installed blog, enter the URL created above for the Zulip endpoint, making sure that the parameters in the URL are delimited by ;

When you are done, your configured webhook should look like this:

{!congrats.md!}

Types of Actions

To configure other actions, choose a supported action from the dropdown list and select the appropriate fields.

  • publish_post
    • Required Fields: post_title, post_type, post_url
    • Blog Type: Both
  • publish_page
    • Required Fields: post_title, post_type, post_url
    • Blog Type: Both
  • user_register
    • Required Fields: display_name, user_email
    • Blog Type: Self-installed only
  • wp_login
    • Required Fields: user_login
    • Blog Type: Self-installed only