Onboarding Webhook Reference
Payload reference for the BUSINESS_CREATION onboarding webhook
Overview
The onboarding webhook notifies your system when a business is created through your integration. This page describes the BUSINESS_CREATION event, including its payload structure, field definitions, and an example payload, so you can build and test your webhook receiver.
Before You Begin
Make sure you have:
- A DoorDash developer account and your
developer_id. - A publicly reachable HTTPS endpoint that can receive
POSTrequests with a JSON body.
Event types
| Event | Description |
|---|---|
BUSINESS_CREATION | Sent when a business is created for your integration. |
Example payload
{
"webhook_type": "BUSINESS_CREATION",
"developer_id": 5555555555,
"event_id": "00000000-0000-0000-0000-000000000000",
"timestamp": "2026-01-01T00:00:00.000000Z",
"business_id": 5555555555,
"description": "Test Business",
"external_business_id": "Test Business 1",
"business_name": "Test Business",
"created_at": "2026-01-01T00:00:00.000000Z",
"update_at": "2026-01-01T00:00:00.000000Z",
"activation_status": "initiated",
"external_metadata": {
"number_of_stores": 1,
"client_phone_number": "+15555555555",
"external_store_ids": [""]
},
"is_test": false,
"partnership_ids": ["test_partnership_id_1", "test_partnership_id_2"]
}
Payload fields
Top-level fields
| Field | Type | Description |
|---|---|---|
webhook_type | string | The event type. Currently BUSINESS_CREATION. |
developer_id | integer | Your DoorDash developer ID. |
event_id | string (UUID) | Unique identifier for this event. |
timestamp | string (ISO 8601, UTC) | When the event was sent. |
business_id | integer | DoorDash's identifier for the business. |
description | string | Description of the business. |
external_business_id | string | Your identifier for the business. |
business_name | string | Name of the business. |
created_at | string (ISO 8601, UTC) | When the business was created. |
update_at | string (ISO 8601, UTC) | When the business was last updated. |
activation_status | string | Activation status of the business, for example initiated. |
external_metadata | object | Additional details about the business. See external_metadata. |
is_test | boolean | true if the business is a test business. |
partnership_ids | array of strings | Identifiers of the partnerships associated with the business. |
external_metadata
| Field | Type | Description |
|---|---|---|
number_of_stores | integer | Number of stores associated with the business. |
client_email | string | Contact email for the business. |
client_phone_number | string | Contact phone number for the business, in E.164 format. |
external_store_ids | array of strings | Your identifiers for the business's stores. |
note
Use event_id to deduplicate events. Your receiver should handle receiving the same event more than once without creating duplicate records.
FAQ
Which fields were added most recently?
event_id and partnership_ids are the most recent additions to the payload. All other fields are unchanged.
How do I match a webhook to a business in my system?
Use external_business_id, which is your own identifier for the business. business_id is DoorDash's identifier for the same business.
How do I tell test businesses from live ones?
Check the is_test field. It is true for test businesses.
Was this page helpful?