Skip to main content
POST
/
v2
/
export-job-events
Create an Export Job Event
curl --request POST \
  --url https://external.pleo.io/v2/export-job-events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "event": "started",
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failureReason": "<string>",
  "failureReasonType": "invalid_configuration"
}
'
{
  "type": "INVALID_EXPORT_JOB_STATUS_CHANGE",
  "message": "Export Job status change failed"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json;charset=UTF-8
​
event
enum<string>
required
Available options:
started,
failed,
completed,
completed_with_errors
​
jobId
string<uuid>
required

Identifier of the job the event is to be processed for.

​
failureReason
string

Reason why the job failed in the case of a failure. Include this only when the export job event has a failed status.

​
failureReasonType
enum<string>
Available options:
invalid_configuration,
missing_configuration,
authentication_failure,
accounting_system_authentication_failure,
pleo_rate_limit,
accounting_system_rate_limit,
service_unreachable,
accounting_system_unreachable,
validation_failure,
authorization_failure,
integration_unusable,
job_expired,
service_timeout,
accounting_system_timeout,
canceled_by_user

Response

Export Job Event created successfully.