Skip to content
Developer home


  Less than to read

How to use the API Webhooks

Our API Webhooks functionality will allow you to receive automatic updates on events that occur while using Sage People e.g when a new Employee is created, deleted or updated, you will be able to set up a Webhook which can notify you of which Employee the event has occurred on. To use the API Webhooks, you will first need to create a Named Credential inside your Salesforce org. A Named Credential is a Salesforce object which holds the endpoint you would like the updates to be sent to. To create a Named Credential:

  1. Navigate to Setup.
  2. Search for Named Credentials in the Quick Find box (under security section).
  3. Select on New Named Credential.
  4. Give your Named Credential a Label (this will be used in List views and reports).
  5. Give a Name for this Named Credential.
  6. In the URL section, give the URL of the endpoint you would like the updates to be sent to.
  7. Save the Named Credential.

    Named Credential for Webhook

Once you have created a Named Credential, you will need to create an instance of the Webhook Object which will hold a reference to the Named Credential you have just created. This is a Custom Metadata Type we have created to allow flexibility when creating and configuring Webhooks.

  1. Navigate to Setup.
  2. Search for Custom Metadata Types.
  3. Select on Manage Records on the Api Change Event Webhook Metadata type.
  4. Select on New.
  5. Enter the Label and Name for this Webhook.
  6. On the Named Credential Name box, give the exact Name of the Named Credential which holds the endpoint for this Webhook.
  7. Tick the checkbox of the Object you would like to receive updates on e.g Employee.
  8. You also have the option to make this Webhook active or not active by ticking the Active checkbox.
  9. Select Save.

    Api Change Event Webhook

At the moment, we only provide Webhooks to Employee Changes, when a new Employee is created or updated then the Id of the Employee is sent to the specified endpoint. The content body of the Webhook will look like the following:

    "id": "a2G7E000000LlIDUA0"