Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Webhooks

Retrieve a webhook

Returns the details of a webhook.

Webhooks create an event when an action that is subscribed to is performed in Shipmondo. The event is then sent to the specified endpoint containing the current data of the affected object.

get/webhooks/{id}

Path parameters

idinteger required

ID for the webhook to be included in the filter

Response

Successful.

idinteger

Unique identifier of the object.

endpointstring

Endpoint the webhook sends request to.

activeboolean

Indicates if the webhook is active.

created_atstring date-time

ISO 8601 datetime the object was created.

updated_atstring date-time

ISO 8601 datetime when the object was updated.

namestring

User-specified name of the webhook.

action'create' | 'cancel' | 'status_update' | 'create_fulfillment' | 'create_shipment' | 'payment_captured' | 'payment_refunded' | 'payment_voided' | 'delete' | 'latest' | 'delivered'

The action that webhook is hooked to.

resource_name'Shipments' | 'Orders' | 'Shipment Monitor'

The name of the resource that webhook is hooked to.

Example response

{
  "id": 1,
  "endpoint": "https://example.com/webhook",
  "created_at": "2017-06-16T06:25:44.557Z",
  "updated_at": "2017-06-16T06:25:44.557Z",
  "name": "Example Name",
  "action": "create",
  "resource_name": "Shipments"
}