Changing Webhook Payload Format for Sync Job Status

Slack Knowledge Base Q&A API, Terraform and Other Topics
, , , ,
1

Summary

The user is looking to modify the payload format received from a webhook to include specific details about a sync job status. They want the data to be structured in a format similar to the provided JSON example.


Question

Hello, I have a requirement to get webhook call whenever a sync job has succeeded or failed.
Using the webhook, in the payload I get the data in the format suitable for a slack message.
However, it does contain the timestamps of the sync, and other essential details,

I want to get the data on webhook request in a format similar to this:

    "data": {
        "workspace": {
            "id":"b510e39b-e9e2-4833-9a3a-963e51d35fb4",
            "name":"Workspace1",
            "url":"<https://link/to/ws>"
        },
        "connection":{
            "id":"64d901a1-2520-4d91-93c8-9df438668ff0",
            "name":"Connection",
            "url":"<https://link/to/connection>"
        },
        "source":{
            "id":"c0655b08-1511-4e72-b7da-24c5d54de532",
            "name":"Source",
            "url":"<https://link/to/source>"
        },
        "destination":{
            "id":"5621c38f-8048-4abb-85ca-b34ff8d9a298",
            "name":"Destination",
            "url":"<https://link/to/destination>"
        },
        "jobId":9988,
        "startedAt":"2024-01-01T00:00:00Z",
        "finishedAt":"2024-01-01T01:00:00Z",
        "bytesEmitted":1000,
        "bytesCommitted":1000,
        "recordsEmitted":89,
        "recordsCommitted":89,
        "bytesEmittedFormatted": "1000 B",
        "bytesCommittedFormatted":"90 B",
        "success":true,
        "durationInSeconds":3600,
        "durationFormatted":"1 hours 0 min"
    }
}```
I am not able to find the way to change the payload to be received from the webhook to the above format.
The docs mention that the data on webhook calls would be in the above format:
<https://docs.airbyte.com/cloud/managing-airbyte-cloud/manage-airbyte-cloud-notifications>

Is there any way to get the information mentioned above in the payload of the webhook request?

Any help with regards to it would be greatly appreciated.


*<http://docs.airbyte.com|docs.airbyte.com>*
*<https://docs.airbyte.com/cloud/managing-airbyte-cloud/manage-airbyte-cloud-notifications|Manage notifications | Airbyte Documentation>*
This page provides guidance on how to manage notifications for Airbyte, allowing you to stay up-to-date on the activities in your workspace.

<br>

---

This topic has been created from a Slack thread to give it more visibility.
It will be on Read-Only mode here. [Click here](https://airbytehq.slack.com/archives/C021JANJ6TY/p1720100413757759) if you want 
to access the original thread.

[Join the conversation on Slack](https://slack.airbyte.com)

<sub>
["webhook", "payload-format", "sync-job", "status", "format-change", "API"]
</sub>
2

Hey <@U06P1R4LKJN>, are you using a recent version of Airbyte? That format was changed relatively recently, so maybe you’re using an old version that only delivers a payload suitable for slack