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.
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.
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.
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.
Recommended Comments