WEP WebHooks

Suggest Edits

When building our payroll integrations, you may want your systems and applications to receive events regarding your payroll as they occur in our Embedded Payroll so that your backend systems can execute actions accordingly. WEP webhooks allow you to receive these real-time updates by listening to events you subscribe to.

When using the WEP WebHooks, you make an HTTP request from our system triggered by the event you had already preset in our system. WEP WebHooks supports calling various webhook endpoints with multiple formats and different data. Our system then sends these updates as data payloads in a specific format determined by your request method.

Methods

These are HTTP request methods that you can use when making WebHooks calls. WEP WebHooks allows you to use:

  • GET method
  • POST method

The request method also determines the format of the real-time update that our system sends to your system and applications after the necessary event is triggered.

Formats

These are the formats in which the real-time updates are sent to your system. WEP WebHooks allows for three formats but is determined by the method of their triggers. The formats are:

  • URL by GET method only
  • JSON by POST method only
  • Form by POST method only

Also, you can limit the number of called webhooks by specifying the required data:

  • All - will call the webhook in all cases
  • Payroll - will call the webhook for Payroll operations
  • Employee - you will be notified about employee changes
  • Document - you will be notified about document changes in the system
  • Client - the webhook will be called in the case of Company changes

WEP WebHooks Registration

However, you must first call the WebHooks registration endpoint(s) to enable WEP WebHooks events. Registration can be at the company level, where only company admins can call it, or at the global level, where only System admins can register them.

Company registration can only be called Admin-level and System-level users for specific companies identified with their Company ID. In contrast, global-level registration can only be called by System-level users.

While registration gives access to our resource, where our WebHooks are created and listen for events, you must also provide and specify a URL where you want to receive the WebHook event payload.

A successful registration for webhook will return a data structure with two essential values:

  • Id- This is the webhook ID, which can be used for testing and deleting the webhook.
  • Key- This is the digital signature key used for signing data from the webhook and can be used to validate webhook calls.

After registration for the WebHooks event you want, our system can then push real-time data to your application WebHook URL (that you provided during registration) when events happen in our system.

Updated 4 months ago