Payload Specification

The webhook payloads are send in the body of the request in JSON format.

Any headers added to the webhook will be added as HTTP request headers.

CDS Imports

DMSACC - Declaration Accepted

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Import_Accepted

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSCLE - Customs Cleared

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Import_CustomsCleared

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSQRY - Customs Query

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Import_DMSQRY

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSCTL - Goods Controlled

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Import_DMSCTL

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSCPI - Payment Reminder

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Import_DMSCPI

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSCPR - Payment Reminder

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Import_DMSCPR

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

CDS Exports

DMSACC - Declaration Accepted

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Export_Accepted

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSCLE - Customs Cleared

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Export_CustomsCleared

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSQRY - Customs Query

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Export_DMSQRY

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSCTL - Goods Controlled

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Export_DMSCTL

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSGER - Exit results not received

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Export_DMSGER

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string

DMSEOG - Goods Exited

Property

Data Type

Required

Value

eventType

string

Yes

CDS_Import_DMSEOG

correlationId

string

mrn

string

Yes

lrn

string

Yes

jobReference

string