Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
API reference

Parcel delivered event

Updated
WEBHOOKparcel.deliveredView examples
Read as Markdown

Fictional API example. This page demonstrates documentation features; its operations do not describe a live service.

This webhook reference is generated from the OpenAPI description. The provider sends this event to the receiver.

OpenAPI for this operation: Download JSON.

Webhook: parcel.delivered

The provider sends a POST request for this event to the receiver's webhook URL.

Parcel delivered event

The service sends this event to the receiver's webhook URL.

Authentication

Use one of these authentication options:

Bearer token

HTTP bearer (JWT).

Short-lived service token.

API key

API key in header X-Parcel-Key.

Long-lived account key.

Request body

Required.

application/json

5 properties

  • eventId string required ⓘ

  • parcelId string required ⓘ

  • occurredAt string required ⓘ

    format: date-time

  • outcome enum<string> required ⓘ

    Available options: "delivered", "returned"

  • proof one of several types required ⓘ

    Use exactly one of these shapes:

    Photo proof · 2 properties

    object

    2 properties

    • kind string required ⓘ

      const: "photo"

    • url string required ⓘ

      format: uri

    Signature proof · 2 properties

    object

    2 properties

    • kind string required ⓘ

      const: "signature"

    • signedBy string required ⓘ

Responses

204: No Content

Receiver accepted the event.