Checking the status of a bulk export of failed events job

📘
Webhooks v3 bulk export of failed events is a new Identity Cloud feature currently in limited availability. Because the feature isn't in general release, that means that both the product, and this documentation, are subject to change at any time.

The /exports endpoint enables you to check the status of all your jobs, including active jobs, completed jobs, and cancelled jobs. If you’d prefer to check the status of a particular job (e.g., the job you started a few minutes ago), simply add the job ID to the end of your API call. For example, this call returns the status of the job with the job ID a22c9604-7b27-464f-bff5-83ba229323af:

curl -L -X \
  GET 'https://v1.api.us.janrain.com/e0a70b4f-1eef-4856-bcdb-f050fee66aae/webhooks/subscriptions/e26925c7-ca17-4b82-8530-e43158c2d63a/events/exports/a22c9604-7b27-464f-bff5-83ba229323af' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer Yh1cEVzUOy0lZNaBxcGbQRQ6qFaRvW0UBqTD81p76ymSNN73P6eulMZFX2-MkN1h'

That returns a response similar to this:

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "state": "processing",
  "_links": {
    "self": {
      "href": "/e0a70b4f-1eef-4856-bcdb-f050fee66aae/webhooks/subscriptions/e26925c7-ca17-4b82-8530-e43158c2d63a/events/exports/a22c9604-7b27-464f-bff5-83ba229323af"
    },
    "exports": {
      "href": "/e0a70b4f-1eef-4856-bcdb-f050fee66aae/webhooks/subscriptions/e26925c7-ca17-4b82-8530-e43158c2d63a/events/exports"
    }
  }
}

The state property reports back the current status of the job. Meanwhile, the self property provides a link for downloading the file. Just add the /download endpoint to the end of the URL. For example:

/e0a70b4f-1eef-4856-bcdb-f050fee66aae/webhooks/subscriptions/e26925c7-ca17-4b82-8530-e43158c2d63a/events/exports/a22c9604-7b27-464f-bff5-83ba229323af/download

See also