Skip to main content
GET
/
event
/
pull
/
{eventId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "tenantId": 123,
  "masterCatalogId": 123,
  "catalogId": 123,
  "siteId": 123,
  "topic": "<string>",
  "entityId": "<string>",
  "isTest": true,
  "correlationId": "<string>",
  "extendedProperties": [
    {
      "key": "<string>",
      "value": "<unknown>"
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

eventId
string
required

Unique identifier of the event. System-supplied and read-only.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

The external/public Event entity used specifically in PULL/POLL event scenarios

id
string | null

The unique identifier for an event

tenantId
integer<int32> | null

TenantId

masterCatalogId
integer<int32> | null

MasterCatalogId

catalogId
integer<int32> | null

CatalogId

siteId
integer<int32> | null

SiteId

topic
string | null

The topic of the event (i.e. product.created)

entityId
string | null

The identifier / ID of the entity that changed (i.e. product code)

isTest
boolean | null

Is this a test?

correlationId
string | null

The Correlation Id of the original API request that caused this event to occur

extendedProperties
object[] | null

Extended properties. Note: This is purposefully not a CollectionBase type wrapper so consumers start to get used to not having counts returned.

auditInfo
object