Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 2.78 KB

webhookupdaterequest.md

File metadata and controls

23 lines (18 loc) · 2.78 KB

WebhookUpdateRequest

Example Usage

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

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

Fields

Field Type Required Description Example
event components.WebhookEventTypeEnum ✔️ Type of event that triggered the webhook.
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