EPepilot
erp

getErpUpdateEvent

Changed on

Returns one interactive event's processing record, without waiting.

Records exist for events processed as interactive (the ingest result said interactive: true) and are kept for 24 hours. Any other event id is a 404.

Requires integration:view on the event's integration.

get/v3/erp/updates/events/{event_id}

Request

  • Base URL
    https://integration-toolkit.sls.epilot.io
  • URL
    https://integration-toolkit.sls.epilot.io/v3/erp/updates/events/{event_id}
  • Auth
    HTTP bearer

Path parameters

event_idstring required

The event_id from the ingest result.

Response

The event's processing record

event_idstring required
correlation_idstring
integration_idstring
status'accepted' | 'processing' | 'done' | 'partial' | 'error' required

accepted until the mapping ran, processing while its writes run, then one of the terminal states: done, partial (something was written but a write or part of the mapping failed) or error (nothing was written).

lane'interactive' | 'priority' | 'default' | 'deferred' required

Which processing lane carried the event.

use_case_idstring
use_case_slugstring
event_namestring

The partner's own name for the event, as pushed.

ingested_atstring date-time required
mapped_atstring date-time

When the event's mapping finished.

done_atstring date-time

When the event reached a terminal status.

writes_totalinteger required

The entity writes the event fanned out into so far.

writes_doneinteger required

The entity writes that have finished.

entities_omittedinteger

Entity writes of the event that are not in entities: an event lists at most 200. The entities were written all the same; they are only missing from the list. Present only when there are any.

errors_totalinteger required

Every failure the event had, including those not listed in errors.

Example response

{
  "entities": [
    {
      "slug": "contact",
      "unique_ids": {
        "reenumber": "4711"
      }
    }
  ]
}

Changes

  • ef6bbb0d5a31Revision changes
    • info

      added the optional property to the response with the status

  • 53e2cdce2751Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status