GOgoshippo
Webhooks

Retrieve a specific webhook

Returns the details of a specific webhook using the webhook object ID.

get/webhooks/{webhookId}

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/webhooks/{webhookId}
  • Auth
    API key in header Authorization

Path parameters

webhookIdstring required

Object ID of the webhook to retrieve

Response

Webhook

eventstring required

Type of event that triggers the webhook.

urlstring required

URL webhook events are sent to.

activeboolean

Determines whether the webhook is active or not.

is_testboolean

Determines whether the webhook is a test webhook or not.

object_createdstring date-time

Timestamp of the creation of the webhook.

object_idstring

Unique identifier of the webhook. This can be used to retrieve or delete the webhook.

object_updatedstring date-time

Timestamp of the last update of the webhook.

object_ownerstring

Username of the user who created the webhook.

Example response

{
  "event": "track_updated",
  "url": "https://example.com/shippo-webhook",
  "active": true
}

Changes

No recorded changes to this operation across all 14 revisions of this API.