Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials.

Headers

webhook-id
string
required

Delivery identifier included in the signature input.

webhook-timestamp
string
required

Unix timestamp in seconds included in the signature input.

webhook-signature
string
required

One or more Standard Webhooks v1 signatures for the raw request body.

Body

application/cloudevents+json

Any signed Bahn order webhook event.

specversion
any
required

CloudEvents specification version.

id
string
required

Stable event ID. Use it to deduplicate retries and replays.

source
string<uri>
required

Bahn API origin for the event environment. Resolve resource paths against this origin.

subject
string
required

Order subject in the form orders/{order_id}.

time
string<date-time>
required

Time when the event occurred.

datacontenttype
any
required

Media type of the event data.

type
enum<string>
required

Stable event type that identifies the changed resource or order area.

Available options:
com.bahn.order.updated.v1,
com.bahn.order.pickup_readiness.changed.v1,
com.bahn.order.schedule.changed.v1,
com.bahn.order.files.updated.v1,
com.bahn.order.inspection_report.available.v1
data
object
required

Order identity and URLs for reading current state.

Response

204

The receiver stored the event.