Ministry Sync Developer Resources
Menu

Introduction

Webhooks & how they work with Ministry Sync

Webhooks, according to wikipedia are...

...a method of augmenting or altering the behaviour of a web page, or web application, with custom callbacks. These callbacks may be maintained, modified, and managed by third-party users and developers who may not necessarily be affiliated with the originating website or application... Wikipedia

How do webhooks work within Ministry Sync?

Ministry Sync webhooks can communicate with external or third-party systems. When an action or event happens inside of a Ministry Sync app, an HTTP Request is made to an endpoint (a url that can accept POST requests) that is specified in the Webhooks section of your account settings.

There is great flexibility using webhooks. You can set up your webhook integration to only trigger on a specific action and/or for a specific FundEasy or AttendEasy Event.

Webhook flow with Ministry Sync

What are the requirements on my end?

  • A server capable of receiving HTTP POST requests with a Content-type of application/json
    This will need to be set up on your own webserver. That is one of the beauties of webhooks. How you handle the data is up to you!

  • Your server should respond with a status code of 200 or 201 to tell us that everything was succsessful and we should not keep trying*.

*Our delivery service will retry for up to 12 hours after which it will disable your webhook in your Ministry Sync integrations dashboard. The account's Technical Contact and alert email (if available) will be notified of these failures.


Sounds great. How do I set it up in Ministry Sync?

Proceed to the Getting Started section.

Copyright © 2019 Ministry Sync. All rights reserved.