Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 4.94 KB

webhook.md

File metadata and controls

27 lines (22 loc) · 4.94 KB

Webhook

Example Usage

import { Webhook } from "shippo/models/components";

let value: Webhook = {
  event: "track_updated",
  url: "https://example.com/shippo-webhook",
  active: true,
  isTest: false,
};

Fields

Field Type Required Description Example
event string ✔️ Type of event that triggers the webhook. track_updated
url string ✔️ URL webhook events are sent to. https://example.com/shippo-webhook
active boolean ➖ Determines whether the webhook is active or not. true
isTest boolean ➖ Determines whether the webhook is a test webhook or not. false
objectCreated Date ➖ Timestamp of the creation of the webhook.
objectId string ➖ Unique identifier of the webhook. This can be used to retrieve or delete the webhook.
objectUpdated Date ➖ Timestamp of the last update of the webhook.
objectOwner string ➖ Username of the user who created the webhook.