Skip to main content

API Notifications

If a job is created via the API, Jadu Central will notify the callback URL of the corresponding API application when the job's status changes via a HTTP POST.

Job Exporting​

Notification Parameters​

| Name | Description | |-:-|-:-|:--| | executed_at | The date the job started processing, in RFC3339 format. | | status | Always "exporting". | | job_identifier | The ID of the job that has started processing. |

Example Notification Body​

{
    "executed_at": "2020-03-09T14:40:04+00:00",
    "status": "exporting",
    "job_identifier": 330
}

Job Completed​

Notification Parameters​

| Name | Description | |-:-|-:-|:--| | executed_at | The date the job started processing, in RFC3339 format. | | status | Always "completed". | | job_identifier | The ID of the job that has started processing. | | total_exported | The total number of records exported. | | files | An array of files objects (see below) |

File Object​

| Name | Description | |-:-|-:-|:--| | filename | The name of the export file | | type | The type of data contained within the file (data, supplementary, uploads or pdfs) | | checksum | SHA1 hash of the file for ensuring file integrity after downloading | | url | The URL to access the file |

Example Notification Body​

{
    "status": "completed",
    "files": [
        {
            "filename": "11_20200309144004_163_data.csv",
            "type": "data",
            "checksum": "bcc4e340a212b0de8b216924517aed3a9232159e",
            "url": "https:\/\/www.mywebsite.com\/11\/job\/330\/file\/1002"
        },
        {
            "filename": "11_20200309144004_163_data_1199.csv",
            "type": "supplementary",
            "checksum": "966285862d518bdfc14a52716541afa9f05e2e0d",
            "url": "https:\/\/www.mywebsite.com\/xfp\/export\/11\/job\/330\/file\/1003"
        },
        {
            "filename": "11_20200309144004_163_uploads.zip",
            "type": "uploads",
            "checksum": "4146afe7fb6d239436ea8df3032d2affc0572897",
            "url": "https:\/\/www.mywebsite.com\/xfp\/export\/11\/job\/330\/file\/1004"
        },
        {
            "filename": "11_20200309144004_163_pdfs.zip",
            "type": "pdfs",
            "checksum": "5562b7b427559aeaf51b71e6561956b40a9008bb",
            "url": "https:\/\/www.mywebsite.com\/xfp\/export\/11\/job\/330\/file\/1005"
        }
    ],
    "job_identifier": 330,
    "executed_at": "2020-03-09T14:40:04+00:00",
    "total_exported": 2
}

Job Failed​

Notification Parameters​

| Name | Description | |-:-|-:-|:--| | executed_at | The date the job started processing, in RFC3339 format. | | status | Always "failed". | | job_identifier | The ID of the job that has started processing. | | error | A description of the error that occurred. |

Example Notification Body​

{
    "executed_at": "2020-03-09T14:40:04+00:00",
    "status": "failed",
    "job_identifier": 330,
    "error": "No space left on disk"
}

Debugging notifications​

To aid debugging of API notifications, it is possible to replay a notification via the Control Center. To resend an API notification:

  1. Navigate to Data Management under Forms, create a new export or choose an existing export and click on the Log tab.
  2. Click API.
  3. Choose the notification to replay, by clicking Details to verify the contents to be replayed.
  4. Click Replay on the selected row.
  5. Your application will receive the notification, with the same content as before.