Webhook

You can define webhook for your application to receive events of Iswigo. Contact us to define a webhook for your application.

Security

We sign the webhook request with X-Iswigo-Signature header like the requests done on API. Refer to Signature page to control signature.

Events

"connection.status"

Example for a finished synchronization:

{
    "event_id": "f8798a05-b15d-4c60-883b-8772c0aec3b6",
    "create_time": "2020-04-24T16:46:27+00:00",
    "type": "connection.status",
    "data": {
        "connection_id": "9de67679-d433-432c-9560-8612377fc124",
        "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
        "status": "finished",
        "step": null,
        "progression": null
    }
}

Example for an in progress synchronization:

{
    "event_id": "f8798a05-b15d-4c60-883b-8772c0aec3b6",
    "create_time": "2020-04-24T16:46:27+00:00",
    "type": "connection.status",
    "data": {
        "connection_id": "9de67679-d433-432c-9560-8612377fc124",
        "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
        "status": "in progress",
        "step": null,
        "progression": 35
    }
}

Refer to "Status of connection" API route to known status list.