doordash · Schema

OnboardingWebhookPayload

OnboardingWebhookPayload schema from DoorDash API

Properties

Name Type Description
event_type string The type of onboarding event.
store_id string The merchant-supplied store identifier.
status string The onboarding status.
message string Additional details about the onboarding event.
timestamp string When the onboarding event occurred.
View JSON Schema on GitHub

JSON Schema

doordash-onboarding-webhook-payload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/doordash/refs/heads/main/json-schema/doordash-onboarding-webhook-payload-schema.json",
  "title": "OnboardingWebhookPayload",
  "description": "OnboardingWebhookPayload schema from DoorDash API",
  "type": "object",
  "properties": {
    "event_type": {
      "type": "string",
      "description": "The type of onboarding event.",
      "enum": [
        "store_activated",
        "store_deactivated",
        "onboarding_completed",
        "onboarding_failed"
      ],
      "example": "store_activated"
    },
    "store_id": {
      "type": "string",
      "description": "The merchant-supplied store identifier.",
      "example": "D-12345"
    },
    "status": {
      "type": "string",
      "description": "The onboarding status.",
      "example": "active"
    },
    "message": {
      "type": "string",
      "description": "Additional details about the onboarding event.",
      "example": "example"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "When the onboarding event occurred.",
      "example": "2026-06-02T14:30:00Z"
    }
  }
}