Canceling 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.

If you start a job and then change your mind, use the /exports/{jobId} endpoint and the DELETE method to cancel that job. When you do that, Webhooks v3 stops processing the ob and no file is written to the Amazon S3 bucket. In addition to that, no changes of any kind are made to the failed events table. In other words, everything is put back exactly the way it was before you started the job.

To cancel a ob, use an API call similar to the following:

curl -L -X DELETE \
  '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'

When a job is cancelled the response should reflect that new status:

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "state": "canceled",
  "_links": {
    "self": {
      "href": "/{customerId}/webhooks/subscriptions/{subscriptionId}/exports/{exportId}"
    },
    "exports": {
      "href": "/{customerId}/webhooks/subscriptions/{subscriptionId}/exports"
    }
  }
}

Note that, in some cases, you won’t be able to cancel a job. When you do a bulk export of failed events, Webhooks v3 gathers up all your failed events and then writes a file containing those events to the Amazon Web Services S3 bucket. If you cancel a job before Webhooks starts writing the file then that job will be cancelled. However, if Webhooks has started to write the file then the job can’t be cancelled.

See also