snapcasterDevelopers

    API reference · Types

    WebhookTestEvent

    Part of the payload of webhook.test.

    Type: object

    Example

    Schema example: from the webhook.test payload
    {
  "event_id": "evt_5b0e7c2d9a4f41e8b3c6d1a07f2e9b58",
  "type": "webhook.test",
  "created_at": "2026-09-04T19:00:00.000Z",
  "data": {
    "seller_id": 42,
    "platform_id": 7
  },
  "api_version": "2026-10"
}

    Fields

    event_id string required

    A globally unique event id that stays the same across retries. Use it to deduplicate deliveries (STABLE).

    Example evt_5b0e7c2d9a4f41e8b3c6d1a07f2e9b58

    type string required

    The event type (STABLE).

    Constraints: allowed values: webhook.test Example webhook.test

    created_at string required

    ISO-8601 UTC instant of the change the event reports; unchanged across retries (STABLE).

    Example 2026-09-04T19:00:00.000Z

    data WebhookTestEventData required

    The operation or event payload.

    Show child fieldsHide child fields
    data.seller_id integer required

    The seller whose API key asked for the test. Route the event by it as you route real ones (STABLE).

    Example 42

    data.platform_id integer required

    Your platform, which owns the webhook endpoint (STABLE).

    Example 7

    api_version string required

    The dated API version used for this payload, frozen when Snapcaster queued the delivery. Changing the platform pin does not change queued events or retries; they keep the same version. See https://developers.snapcaster.ca/guide/api-versioning (STABLE).

    Constraints: allowed values: 2026-10 Example 2026-10

    Used by