Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Webhooks

List all webhooks

Returns a list of webhooks.

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

Query parameters

idinteger

ID of the webhook object

namestring

Name of the webhook

activeboolean

The current active status of the webhook

created_at_minstring date-time

"From" timestamp for the webhooks to be included in the filter. Examples:

  • 2017-06-19T11:00:03.305+02:00
  • 2017-06-19 will be transformed into 2017-06-19T00:00:00.000+02:00
created_at_maxstring date-time

"To" timestamp for the webhooks to be included in the filter. Examples:

  • 2017-06-29T11:00:03.305+02:00
  • 2017-06-29 will be transformed into 2017-06-29T00:00:00.000+02:00
updated_at_minstring date-time

"From" value of "updated" timestamp for the webhooks to be included in the filter. Examples:

  • 2018-06-19T11:00:03.305+02:00
  • 2018-06-19 will be transformed into 2017-06-19T00:00:00.000+02:00
updated_at_maxstring date-time

"To" value of "updated" timestamp for the webhooks to be included in the filter. Examples:

  • 2018-06-29T11:00:03.305+02:00
  • 2018-06-29 will be transformed into 2017-06-29T00:00:00.000+02:00
per_pageinteger

For pagination. Defines how many entries are returned per page.

pageinteger

For pagination. Defines which page the results are fetched from.

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"
  }
]