Skip to content
/SendingEvents

SendingEvents

Entity representing a mail to be sent to one recipient using a specific Workflow.

Operations

Retrieve SendingEvent Based on ID

Request

Retrieve SendingEvent based on ID

Security
api_key
Path
idstringrequired

Unique identifier of the SendingEvent to be retrieved

Headers
x-managed-company-idstring

Optional: the ID of the managed company on behalf of which the request is made

curl -i -X GET \
  'https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/sending-events/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Successful response with the SendingEvent

Bodyapplication/json
idstringrequired

SendingEvent's identifier

jobIdstringrequired

Identifier of the SendingEvent's Job

jobNamestringrequired

Name of the SendingEvent's Job

sendingSourceFileReferencestring

Identifies the source file that produced this sending: its path within the uploaded ZIP, or its original submitted filename for a direct upload.

Example:"documents/document.pdf"
jobAuthorstring

Username of the author of the SendingEvent's Job

startDatestring, (date-time)required

The Datetime denoting the moment of Job creation

endDatestring, (date-time)

The Datetime denoting the moment the sending event reached a final status

executionDateUtcstring, (date-time)

Datetime of the scheduled SendingEvent execution in UTC

propertiesArray of objects(SendingPropertyDto)required

SendingEvent's properties

extraInfoArray of objects(ExtraInfoDto)required

SendingEvent's extra information

workflowNamestringrequired

Name of the Workflow used to create the SendingEvent's Job

statusstringrequired

TechnicalStatus of the SendingEvent

Enum:"IN_PROGRESS""SUCCESS""WARNING""FAILURE"
businessStatusstringrequired

BusinessStatus of the SendingEvent

Enum:"NOT_STARTED""SCHEDULED_FOR_EXECUTION""IN_PROGRESS""SUCCESS""FAILURE""REJECTED"
approvalobject(SendingEventApprovalDto)

Approval information for the SendingEvent

errorListArray of objects(CustomErrorDto)required

SendingEvent's error list

warningListArray of objects(CustomErrorDto)required

SendingEvent's warning list

invoiceIdstring

Identifier of the invoice if the SendingEvent has been built using a Workflow Collection

dataRetentionobject(SendingEventDataRetentionDto)required

Data retention policy for the SendingEvent

workflowIdstringrequired

Identifier of the Workflow used to create the SendingEvent's Job

documentsArray of objects(SendingEventDocumentDto)required

SendingEvent's documents

taskDetailsArray of anyrequired

Details of tasks associated with the SendingEvent

Response
{
  "id": "string",
  "jobId": "string",
  "jobName": "string",
  "sendingSourceFileReference": "documents/document.pdf",
  "jobAuthor": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "executionDateUtc": "2019-08-24T14:15:22Z",
  "properties": [
    { … }
  ],
  "extraInfo": [
    { … }
  ],
  "workflowName": "string",
  "status": "IN_PROGRESS",
  "businessStatus": "NOT_STARTED",
  "approval": {
    "userId": "string",
    "username": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "errorList": [
    { … }
  ],
  "warningList": [
    { … }
  ],
  "invoiceId": "string",
  "dataRetention": {
    "periodInSeconds": 0
  },
  "workflowId": "string",
  "documents": [
    { … }
  ],
  "taskDetails": [
    { … }
  ]
}