How to create & manage Webhooks?

How to create & manage Webhooks?

Webhooks are the foundation of modern API development. They enable you to listen to changes in our systems and trigger external system actions such as sending a text message, updating payment status, etc,. Zuper supports webhooks out of the box and allows our user to register a HTTP/HTTPS URL when an event happens in Zuper.

New, Update, and Delete are enabled to manage the webhooks. so the application doesn’t have to make periodic calls to APIs while it’s waiting for changes; new updates are added to the webhook.

Webhook Settings:

1. Select the “Settings” module from the left navigation panel. 

2. Select the “Webhooks” sub-module from the “Settings” module. 

3. Tap on the “+New Webhook” option to create a fresh webhook.  

Webhook - Activate / Deactivate

Navigation:  Settings  --> Other Settings --> Webhooks --> Activate / Deactivate Webhooks

A Webhook is a lightweight API that helps data sharing. Now the user controls the temporary activation/deactivation of the webhooks, which helps whenever the webhooks are required to carry out the integration process smoothly. 

A.    Deactivate Webhook:

     1.      Select the "Settings" module from the left panel, and under the "Other Settings," select the "Webhooks."

2. Select the "Deactivate" icon to inactivate the webhooks.

3.  On the "Deactivate Webhook" pop-up, select the "Deactivate" button.

4.  The webhook is deactivated successfully.

By following the above steps, the webhook is deactivated successfully.

Activate Webhook:

1. Select the "Settings" module from the left panel, and under the "Other Settings," select the "Webhooks."

2. Select the "Activate (Tick Mark)" icon to inactivate the webhooks.

3. On the "Activate Webhook" pop-up, select the "Activate" button.

4. The webhook is activated successfully.

Best Practices /Recommendations:

Webhooks provide a powerful method to track the state of record and to take actions within the Zuper account. Review these best practices to ensure your webhooks remain secure and function seamlessly with any external integration,

1. Subscribing to Events: Your webhook endpoints should be configured to receive only the types of events required for your integration. Listening for extra events (or all events) will put undue strain on your server and is not recommended.

2. Handling Duplicate Events: Webhook endpoints might unlikely but may receive the same event more than once. We advise you to guard against duplicated events by making your event processing idempotent. One way of doing this is logging the events you’ve processed and then not processing already-logged events.

3. Order of Events: We may not guarantee delivery of events in the order in which they are generated. The endpoint that is subscribed to the webhook shouldn’t expect delivery of these events in this order and should handle this accordingly. 

4. Retry logic: Zuper tries to deliver your webhooks up to three times with an exponential backoff in case your endpoint configured doesn't return a 2XX success status HTTP code. Webhooks can be manually retried after this time in the Webhook History under Settings.

    • Related Articles

    • How to create & manage Service Tasks?

      Our Zuper’s new feature, Service Tasks, helps the field executives complete each service task mapped to the jobs. Service tasks are used to create process steps, or checklists, for the field technician to follow when completing a work order and can ...
    • How to create a new invoice from V3 Zuper Web App?

      An invoice is an accounting document that a field service business sends to its clients to request payment for the services rendered. 1. Select the “Invoices” icon from the left navigation menu and choose “+ New Invoice” to create a new invoice. 2. ...
    • How to create a Job on the Zuper Mobile app?

      Jobs are the heart of the Zuper Mobile App. It is the core of all field service operations. In Zuper Mobile App, you can create a new job. Create a new Job: 1. Select the "Jobs" module from the top-left hamburger icon . 2. Select the "+“ icon from ...
    • How to create & manage skillset master?

      Skillset Master Using the “Skillset Master” option, it is now easy to create and manage skillset easily by defining the person’s skillset requirements for the Job.   Skillset Validity Duration: Pre-req: Settings -->  Other Settings --> Skillsets  ...
    • How to create a new Job in the V3 Zuper Mobile App?

      Jobs are a critical part of the field service, as this involves major stage-by-stage job creation to completion of the job, which provides major relief for the end users through on-time Job service. It is the core of all field service operations. In ...