Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Webhook

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:webhook"

links

links: { fx:logs: WebhookLogs; fx:statuses: WebhookStatuses; fx:store: Backend.Rels.Store; fx:webhooks: Webhooks; self: Backend.Rels.Webhook }

Type declaration

  • fx:logs: WebhookLogs

    List of all endpoint responses received during webhook delivery attempts.

  • fx:statuses: WebhookStatuses

    List of all webhook delivery attempts and their current states.

  • fx:store: Backend.Rels.Store

    Store this webhook was created in.

  • fx:webhooks: Webhooks

    List of all webhooks for the store.

  • self: Backend.Rels.Webhook

    This resource.

props

props: { date_created: null | string; date_modified: null | string; encryption_key: null | string; event_resource: ("subscription" | "transaction" | "customer")[]; format: "json" | "webflow" | "zapier"; name: string; query: null | string; url: null | string; version: number }

Type declaration

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • encryption_key: null | string

    The JSON webhooks are encrypted in certain situations. This key is also used to generate a signature to verify the integrity of the payload. 1000 characters or less.

  • event_resource: ("subscription" | "transaction" | "customer")[]

    The type of resource to observe changes on.

  • format: "json" | "webflow" | "zapier"

    The type of this webhook. Required.

  • name: string

    The name of this webhook. Required. 255 characters or less.

  • query: null | string

    The webhook payload mirrors the API, and you can include more or less data according to your needs (using zoom and other modifiers). 1000 characters or less. Something like zoom=items,items:options,customer.

  • url: null | string

    The endpoint where we will send the webhook data. 1000 characters or less.

  • version: number

    The version of this webhook. Should not be modified unless you have specific instructions from Foxy. Default value is 2.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc