Mailchimp · Schema

WebhookInfo

Information about a configured webhook.

CampaignsEmail MarketingMarketing AutomationNewslettersTransactional Email

Properties

Name Type Description
id integer The unique webhook identifier.
url string The webhook URL.
description string A description of the webhook.
auth_key string The key used to generate webhook signatures for verifying webhook authenticity.
events array The events that trigger this webhook.
created_at string When the webhook was created.
last_sent_at string When the webhook last fired.
batches_sent integer Total number of event batches sent.
events_sent integer Total number of events sent.
last_error string The last error received from the webhook URL.
View JSON Schema on GitHub

JSON Schema

mailchimp-transactional-webhook-info-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "WebhookInfo",
  "type": "object",
  "description": "Information about a configured webhook.",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique webhook identifier."
    },
    "url": {
      "type": "string",
      "description": "The webhook URL."
    },
    "description": {
      "type": "string",
      "description": "A description of the webhook."
    },
    "auth_key": {
      "type": "string",
      "description": "The key used to generate webhook signatures for verifying webhook authenticity."
    },
    "events": {
      "type": "array",
      "description": "The events that trigger this webhook."
    },
    "created_at": {
      "type": "string",
      "description": "When the webhook was created."
    },
    "last_sent_at": {
      "type": "string",
      "description": "When the webhook last fired."
    },
    "batches_sent": {
      "type": "integer",
      "description": "Total number of event batches sent."
    },
    "events_sent": {
      "type": "integer",
      "description": "Total number of events sent."
    },
    "last_error": {
      "type": "string",
      "description": "The last error received from the webhook URL."
    }
  }
}