Jump to content
Daniel F
 Share


Introducing Webhooks

Webhooks allow other services and applications to stay in sync with your community data or to perform an action after a specific event occurs in your community.

Webhooks are a performant alternative to continuously polling for changes to the IPS REST API.

I need the last topic.png

For example, a webhook can notify your service when a new topic is created so that your app can perform then any further actions.

Webhooks can also be used to connect your community with Zapier, IFTTT or Integromat, so that any event which is covered by webhooks can trigger any further actions.

Common webhook use cases

  • Sync your member base with 3rd party newsletter lists
  • Sync your Event RSVP with your Online Ticketing System
  • Update your inventory after a purchase was made

You can find the webhook functionality in the AdminCP, under the API section. There is also a useful webhook reference built in.

CleanShot 2022-01-18 at 13.39.45@2x.jpg

Setting up a webhook

Setting up a webhook is straightforward. Log into your AdminCP, then navigate to System > API.

The target URL would be defined by the application you wish to fire events to. For example, in Zapier, you can set up a trigger to listen for a webhook event via a custom URL.

CleanShot 2022-01-18 at 14.59.44@2x.png

Once you have entered the URL, simply check which events you'd like to fire to that URL. Zapier will ask you to test the URL, so to do this simply invoke the action which fires the webhook event, such as creating a test topic.

Documentation

If you are looking to add webhook events into your own custom code and applications, please see our documentation here.

Webhooks will be implemented in 4.6.10 and will be enhanced frequently.

 

 Share

Comments

Recommended Comments

This is great, @Daniel F! I am VERY excited!

 

Having said that... "Setting up a webhook is straightforward. Log into your AdminCP, then navigate to System > API."... When I look in my System area I can't see API. I guess this is because I'm on version version 4.6.9 (the "latest version" according to my Support section) and I need for 4.6.10? Any idea how long before 4.6.10 is rolled out?

Edited by nigeld27
Link to comment
Share on other sites

1 minute ago, Randy Calvert said:

Correct. It’s available starting in 4.6.10. 

IPS won’t comment on when a new version is going to release, but they generally are doing monthly releases now. 

12 days is such a long time to wait. @Daniel F you tease.

 

Do we know if there will be a Webhook that let's me create a Zap trigger based on a Store purchase, or a Zap action to add a secondary group?

 

Excited Lets Go GIF by NOW WE'RE TALKING TV SERIES

 

 

Link to comment
Share on other sites

7 minutes ago, nigeld27 said:

Do we know if there will be a Webhook that let's me create a Zap trigger based on a Store purchase, or a Zap action to add a secondary group?

In the screenshot posted, the very last item is nexusPackageItem_Delete so I would assume there is an added item as well.   There looked to be more, but that was what was on the one page. 

Link to comment
Share on other sites

I have updated the dev guide with some additional information, so any 3rd party devs which are interested into utilising this in their applications and plugins should already be able to implement this on their own to have it ready once 4.6.10 is here

Link to comment
Share on other sites

@Daniel F, it this something we can use internally in IPS? Without 3rd party service?

For example:

  • if user registers, then create a new Welcome PM for him
  • if a database record updated, update the date of the parent record in the reciprocal database (database relationship)
  • if user RSVP an event, join him to closed club
  • if user subscribes to newsletter, gives him achievement points

etc.

Link to comment
Share on other sites

Please add some more webhooks.

  1. When a purchase has gone through Nexus, include all data including custom fields.
  2. When a purchase has been flagged to review.
Link to comment
Share on other sites

It would be excellent if we could craft a custom payload and formatting for the WebHook to send.
For example, I would love to be able to trigger a Discord-ready payload without having to use a middleman tool or write a new module.

Link to comment
Share on other sites


×
×
  • Create New...