How to use webhooks with Backstage

Create Webhooks

Automate processes and exchange information between applications or services with webhooks. In Zoho Backstage, you can create a webhook to transfer data through a URL when certain actions are performed. This way, you can connect different platforms or apps that may not be directly integrated with Backstage.
 
For example, you can create webhooks to notify you when exhibitor requests are placed or when a response is submitted in a custom form. These notifications can be sent to external web servers or third-party services or applications like Zoho Flow. The data received can then be seamlessly transferred to other apps that are integrated with Zoho Flow.
 

 
  1. Go to Portal Settings > Webhooks, from the Portal page. 
  2. Click the Create Webhook button.
  3. Enter a name for the Webhook.
  4. Provide the endpoint URL where you want to receive the data to send as a notification. 
  5. Open the dropdown menu of Event and select the event. 
  6. Select the triggers for the Webhook :
    1. Select the All actions checkbox if you want all the listed triggers to apply.
    2. Alternatively, select individual triggers or sub actions that apply.
  7. Click Save. The Webhook is now created.
These are the triggers that are available in Zoho Backstage.

Event
Created
When an event is created
Updated
When an event is updated
Deleted
When an event is deleted
Microsite
Published
When a microsite is published
Republished
When a microsite is republished
Unpublished
When a microsite is unpublished
Session
Created
When a session is created
Updated
When a session is updated
Deleted
When a session is deleted
Attendee
Created
When an attendee is created at the time of registration
Updated
When an attendee record is updated
Reassigned
When an attendee's ticket is reassigned to another attendee
Deleted
When an attendee is deleted
Attendee status
Checked in
When an attendee has been checked in
Check-in undone
When an attendee's check-in has been undone
Canceled
When an attendee's ticket is canceled
Order
Created
When an order is created
Updated
When an order is updated
Canceled
When an order is canceled
Deleted
When an order is deleted
Order request
Created
When an order request is placed
Approved
When an order request is approved
Rejected
When an order request is rejected
Exhibitor request
Created
When an exhibitor request is placed
Updated
When an exhibitor request is updated
Form response
Created
When a response has been submitted in a custom form or in the Get In Touch form
Updated
When a response submitted in a custom form or in the Get In Touch form has been updated
 

View a webhook 

View details about a webhook that you've created and a history of actions trigged for a particular webhook.



  1. Go to Portal Settings > Webhooks, from the Portal page. 
  2. Click on the name of the Webhook on Webhooks page you want to view and you'll be redirected to another page containing all the Webhook information.
  3. Goto the Details tab to see more details about the Webhook. 
  4. Goto the History tab to see triggers that are executed for the Webhook.

Edit a webhook 

Modify the details you've saved for a webhook and change the actions that trigger it.


  1. Go to Portal Settings > Webhooks, from the Portal page. 
  2. Click the dropdown menu for a Webhook and select the Edit option. The Edit Webhook page will appear. 
  3. Make the necessary changes.
  4. Click Save.

Test a webhook

Send sample data to the endpoint URL you've provided to determine if the data is being transmitted successfully.



  1. Go to Portal Settings > Webhooks, from the Portal page. 
  2. Click the Test button for a webhook. The Test Webhook pop-up box will appear.
  3. Click Send. A confirmation box appears.
  4. Click View Details to see the request sent and the response received in the Request and Response tabs respectively.

Delete a webhook 

Remove webhooks that aren't required anymore.



  1. Go to Portal Settings > Webhooks, from the Portal page. 
  2. Click the dropdown menu for a Webhook and click Delete. The Delete webhook dialogue box will appear.
  3. Click Delete. The Webhook will be deleted.

Note:
  1. When you delete a webhook, you won't be able to receive data for the webhook to the URL provided while setting up the webhook.
  2. Deleting webhooks can't be undone.

Delete multiple webhooks

Delete multiple webhooks at once in Zoho Backstage.



  1. Go to Portal Settings > Webhooks, from the Portal page. 
  2. Select the checkboxes for the Webhooks you want to delete.
  3. Click the Delete button at the top-right corner. The selected webhooks will be deleted.

Note:
  1. When you delete webhooks, you won't be able to receive data for the webhooks to the URL provided while setting up the webhooks.
  2. Deleting webhooks can't be undone.

Using webhooks is a paid feature enabled based on your subscription plan.