Skip to content

module webhook

Global Variables

  • UTF8ENCODING
  • WEBHOOK_CREATE_GQL

function validate

validate(data: Union[str, bytes], hmac_header: str, api_secret_key: str) → bool

function create_http

create_http(
    offline_token: OfflineTokenABC,
    topic: Union[WebhookTopic, str],
    callback_url: str,
    include_fields: Optional[List[str]] = None,
    metafield_namespaces: Optional[List[str]] = None,
    private_metafield_namespaces: Optional[List[str]] = None
) → WebhookResponse

Creates a HTTP webhook subscription.

Uses graphql to subscribe to a webhook and associate it with an HTTP endpoint.

function create_event_bridge

create_event_bridge(
    offline_token: OfflineTokenABC,
    topic: Union[WebhookTopic, str],
    arn: str,
    include_fields: Optional[List[str]] = None,
    metafield_namespaces: Optional[List[str]] = None,
    private_metafield_namespaces: Optional[List[str]] = None
) → WebhookResponse

Creates an Amazon EventBridge webhook subscription.

Uses graphql to subscribe to a webhook and associated it with and AWS Event Bridge with ARN (Amazon Resource Name)

function create_pub_sub

create_pub_sub(
    offline_token: OfflineTokenABC,
    topic: Union[WebhookTopic, str],
    pub_sub_project: str,
    pub_sub_topic: str,
    include_fields: Optional[List[str]] = None,
    metafield_namespaces: Optional[List[str]] = None,
    private_metafield_namespaces: Optional[List[str]] = None
) → WebhookResponse

Creates a Google Cloud Pub/Sub webhook subscription.

Uses graphql to subscribe to a webhook and associate it with a Google PubSub endpoint

class WebhookTopic

An enumeration.

class WebhookResponse

property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".

property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.

class WebhookCreate

An enumeration.

This file was automatically generated via lazydocs.