Getting Started with Webhooks

Follow these steps to set up and start using webhooks with Zenegy.

Step 1: Sign Up for Webhook Access

To get started, you need to sign up by sending an email to our API team. (We are working on a better way, but stay patience) Please send your request to api@zenegy.com with the following information:

  1. Client ID for the App: Your unique client identifier.
  2. Name of the Webhook: A descriptive name for your webhook.
  3. Purpose of the Webhook: Briefly describe what the webhook will be used for.
  4. Callback URL: The URL where you want the webhook data to be sent.
  5. Contact Email: Your contact email for any communication related to the webhook.
  6. Required Event Notifications: Specify the webhook events you need, as described in our guides:

Step 2: Understanding the Webhook Data Structure

Once your webhook is set up, our system will send JSON-formatted data to your specified callback URL. The data structure is as follows:

Copy
Copied
{
  "action": "string",
  "type": "string",
  "referenceUid": "uuid",
  "accountUid": "uuid"
}

Data Fields:

  • action: The type of action that triggered the webhook (e.g., created, updated).
  • type: The category of the item affected by the action (e.g., employee, payroll).
  • referenceUid: A unique identifier for the reference item (e.g. Employee uuid).
  • accountUid: The unique identifier for the account associated with the event (Also refered to as Company uuid).

Note: Ensure your system is correctly configured to receive and process this JSON data structure.