Webhook Notification Payload

The webhook notification that Visier sends to your registered endpoint contains authentication details and JSON content describing the event, such as job IDs and data version numbers.

Overview

When the configured event type occurs, Visier sends an API request to your registered endpoint. The API request payload contains authentication details and JSON content describing the event, such as job IDs and data version numbers.

Webhook notifications from Visier contain the following headers:

Authorization (optional): If you provided credentials for the webhook, Visier sends the Authorization header to authenticate against the receiving entity.
x-visier-signature: An HMAC signature generated from the provided keyName for the webhook.

Webhook notification for job success, failure, and reschedule events contain the following job ID fields:

jobId: The job that triggered the webhook notification.
rootJobId: The top-level job that eventually spawned the job that triggered the webhook notification.
parentJobId: The parent job of the job that triggered the webhook notification.

Example: Let's say Receiving Job A spawned Processing Job B. Processing Job B spawned Processing Job C. Processing Job C triggered the webhook notification. In this example:

jobId is Processing Job C.
rootJobId is Processing Job A.
parentJobId is Processing Job B.

For more information about jobs, see Jobs.

Alert notification payload

The following code sample is an example of the API payload for an alertNotification event type notification. For more information about alerts, see Personalized Alerts.

Copy

Payload for alertNotification event type

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "timestamp": "1755538611507",
  "eventId": "d8cd0c56-c636-398e-85fb-2ec6b1d2e61a",
  "eventType": "ALERT_NOTIFICATION",
  "event": {
    "recipientId": "e7401580-7732-0c4b-a8f2-36de300fb3bb",
    "tenantCode": "WFF_j1r~c7o",
    "alertNotificationId": "d8cd0c56-c636-398e-85fb-2ec6b1d2e61a",
    "alertId": "ec4cb8f0-7c59-11f0-ac46-9bf4baec3b09",
    "createdDate": "1755538611507",
    "alertDetails": {
      "triggerType": "DV_UPDATE",
      "triggerCriteria": {
        "groupedMetricValueThreshold": {
          "metric": {
            "id": "employeeCount",
            "timeHandling": {
              "perPeriod": true
            }
          },
          "relativeTimePeriod": {
            "allowPartialPeriod": true,
            "periodCount": 1
          },
          "ruleSet": {
            "compareTo": {
              "noComparison": {}
            },
            "rules": [
              {
                "relativeToValueRule": {
                  "rulePredicate": "GREATER_THAN",
                  "comparand": 3
                }
              }
            ]
          }
        }
      }
    }
  }
}

Job result success payload

The following code sample is an example of the API payload for a jobResultSuccess event type notification.

Copy

Payload for jobResultSuccess event type

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "timestamp": "1743718453610",
    "eventId": "c0c91580-ce09-40fd-8f84-39d8578c704b",
    "eventType": "jobResultSuccess",
    "event": {
        "jobid": "00000000-0000-0000-0000-000000000000",
        "rootJobId": "00000000-0000-0000-0000-000000000000",
        "parentJobId": "00000000-0000-0000-0000-000000000000",
        "tenantCode": "WFF_j1r",
        "jobType": "",
        "dataCategoryId": "00000000-0000-0000-0000-000000000000",
        "dataVersion": ""
    }
}

Job result failure payload

The following code sample is an example of the API payload for a jobResultFailure event type notification.

Copy

Payload for jobResultFailure event type

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "timestamp": "1743718453610",
    "eventId": "c0c91580-ce09-40fd-8f84-39d8578c704b",
    "eventType": "jobResultFailure",
    "event": {
        "jobid": "00000000-0000-0000-0000-000000000000",
        "rootJobId": "00000000-0000-0000-0000-000000000000",
        "parentJobId": "00000000-0000-0000-0000-000000000000",
        "tenantCode": "WFF_j1r",
        "jobType": "",
        "dataCategoryId": "00000000-0000-0000-0000-000000000000",
        "dataVersion": "",
        "message": ""
    }
}

Job result rescheduled payload

The following code sample is an example of the API payload for a jobResultRescheduled event type notification.

Copy

Payload for jobResultRescheduled event type

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "timestamp": "1743718453610",
    "eventId": "c0c91580-ce09-40fd-8f84-39d8578c704b",
    "eventType": "jobResultRescheduled",
    "event": {
        "jobid": "00000000-0000-0000-0000-000000000000",
        "rootJobId": "00000000-0000-0000-0000-000000000000",
        "parentJobId": "00000000-0000-0000-0000-000000000000",
        "tenantCode": "WFF_j1r",
        "jobType": "",
        "dataCategoryId": "00000000-0000-0000-0000-000000000000"
    }
}

Data version publish payload

The following code sample is an example of the API payload for a dvPublish event type notification.

Copy

Payload for dvPublish event type

1
2
3
4
5
6
7
8
9
10
{
    "timestamp": "1743718453610",
    "eventId": "c0c91580-ce09-40fd-8f84-39d8578c704b",
    "eventType": "dvPublish",
    "event": {
        "tenantCode": "WFF_j1r",
        "dataCategoryId": "00000000-0000-0000-0000-000000000000",
        "dataVersion": ""
    }
}