Skip to main content
API docs by Redocly

Integrate with Stream Events (0.1)

Download OpenAPI specification:Download

This is a spec for integrating with Stream Events. Please send any feedback or questions to marc@streamorders.com.

Event Handler

This endpoint will be provided by the partner and Stream will send all events to it

header Parameters
X-Stream-Signature
required
string
Request Body schema: application/json
One of
type
required
string
location_id
required
string
reference_id
string

Provider Reference ID for Event

required
object (LocationOrder)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "order.confirmed",
  • "location_id": "loc_123",
  • "reference_id": "your_id_123",
  • "order": {
    }
}

Response samples

Content type
application/json
"string"

Send Webhook Event (Event Provider -> Stream via Webhook)

You will call this endpoint from your system, This is how you will notify Stream with updates.

header Parameters
Stream-Webhook-Signature
string

The HMAC-SHA256 signature of the request body, using the webhook secret as the key.

Request Body schema: application/json
One of
type
required
string
Default: "order.assign.driver"
required
object (GenericEventProviderAssignDriverObject)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "order.assign.driver",
  • "object": {
    }
}