• Venue and event management in the cloud

How Can We Help?


Using Webhook

In this article


What is Webhook

Webhooks are automated calls from example.com to a server. Those calls are triggered when a specific event happens on example.com. For example, if a new user signs up on example.com, the automated call may be configured to ask the server to send out a welcome email.


When to use Webhook?

One common scenario to use Webhook is when your app or platform demands real-time updates, but you don’t want to waste your resources. In this instance, a webhook framework would be beneficial.


Using Webhook in Priava

Priava support Webhooks for both Contacts and Organisations.

  •  You need to register subscription in Priava and in turn Priava system will callback the registered callback URL whenever any contact or organization is updated for a specific tenant. Authentication remains same to pass APIToken and TenantRegion in Request Headers as with other API calls.

 To create subscription:

POST
{{urlprefix}}/api/rest/latest/subscription

Sample InputData:
{
    "subscription_url": "https://callbackdomain.com/path",
    "event": "CREATE_CONTACT/UPDATE_CONTACT/CREATE_ORGANISATION/UPDATE_ORGANISATION"
}

Note: Returns Subscription ID which can be used in update subscription or delete subscription API call.

Sample Response:
{
    "result": 1,
    "success": true
}