Skip to main content
POST
/
v3
/
export-job-events
Create an Export Job Event
curl --request POST \
  --url https://external.pleo.io/v3/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

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Body

application/json;charset=UTF-8
​
event
enum<string>
required
ValueDescription
startedThe integration has started processing the job.
failedThe job has failed due to a connection error, authentication failure, or similar issue.
completedThe job has been successfully processed.
completed_with_errorsThe job has been completed, but only some accounting entries were exported successfully.
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>
ValueDescription
invalid_configurationThis would define a failure reason pertaining to invalid configuration needed to complete the export job or interact with the accounting system.
missing_configurationThis would define a failure reason pertaining to incomplete configuration needed to complete the export job or interact with the accounting system.
authentication_failurePleo API failed to authenticate with the integration service when sending off a WebHook API call.
accounting_system_authentication_failureIntegration service could not authenticate with the accounting system.
pleo_rate_limitIrrecoverable rate limit issue with Pleo API.
accounting_system_rate_limitIrrecoverable rate limit issue with the accounting system.
service_unreachableIntegration service unreachable.
accounting_system_unreachableIntegration service unable to reach accounting system.
validation_failureIrrecoverable validation error making the job unprocessable.
authorization_failureAuthorisation revoked or user no longer has access in the accounting system.
integration_unusableIntegration service blocked or unusable for the customer.
job_expiredJob not updated within expiry time limit.
service_timeoutIrrecoverable timeout communicating with integration service.
accounting_system_timeoutIrrecoverable timeout communicating with accounting system.
canceled_by_userJob was canceled by user.
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.