Skip to content

location/fulfillment_service_integration/errored

Overview

PropertyValue
Webhook typelocation/fulfillment_service_integration/errored
Kafka topiclocation.fulfillment-service-integration.errored
DirectionPlatform → Your endpoint

Description

Fired when an error occurs during the connection or operation of a fulfillment service integration. The integration transitions to ERROR state and may require manual intervention to resolve.

Trigger Conditions

  • The fulfillment service encounters an error during the connection handshake
  • An integration that was previously ACTIVE encounters a connectivity or authentication error
  • The FulfillmentServiceIntegration state transitions to ERROR

Message Envelope

json
{
  "header": {
    "organizationId": "org_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "messageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "webhookId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "type": "location/fulfillment_service_integration/errored",
    "date": "2024-06-11T14:00:00.000Z"
  },
  "body": { ... }
}

Body — Property Table

FulfillmentServiceIntegration Object

FieldTypeNullableDescription
idstring (uuid)NoUnique integration identifier
locationIdstring (uuid)NoThe affected location
fulfillmentServiceIdstring (uuid)NoThe affected fulfillment service
accessTokenstringYesAccess token (may be null or expired)
scopesstring[]NoPermission scopes
stateenumYesAlways ERROR for this event

Full JSON Payload Sample

json
{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "u2v3w4x5-y6z7-8901-abcd-234567890123",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "location/fulfillment_service_integration/errored",
    "date": "2024-06-11T14:00:00.000Z"
  },
  "body": {
    "id": "r9s0t1u2-v3w4-5678-xyza-901234567890",
    "locationId": "j1k2l3m4-n5o6-7890-pqrs-123456789012",
    "fulfillmentServiceId": "s0t1u2v3-w4x5-6789-yzab-012345678901",
    "accessToken": null,
    "scopes": ["fulfillment:read", "fulfillment:write", "inventory:read"],
    "state": "ERROR"
  }
}

Notes

  • state is always ERROR in this event payload.
  • This event should trigger an alert in your integration for manual investigation.
  • An errored integration may be retried or require re-creation depending on the root cause.
  • Delivery orders that were in-flight to the errored service may need to be reassigned to another location.

HappyColis API Documentation