Webhooks
Subscribe to Webhooks
To subscribe to webhooks for all businesses a Biz Owner has access to send an authenticated POST request to the https://api.yelp.com/v3/webhooks.
Note: Currently only leads_event webhooks are supported (NEW_EVENT, CONSUMER_PHONE_NUMBER_OPT_IN_EVENT, CONSUMER_PHONE_NUMBER_OPT_OUT_EVENT).
A webhook subscription will have a default expiration date of 14 days. To ensure no loss of data, it is recommended you unsubscribe and subscribe again at least an hour before the expiration date and time.
post/
Request
- Base URLhttps://api.yelp.com
- AuthHTTP bearer
Request body application/x-www-form-urlencoded
Example request
{
"webhook_url": "https://example.com/webhook/123",
"webhook_type": "leads_event",
"restricted_business_ids": [
"w-WAiKJe__oZV13M34pTFw"
]
}Response
200 OK - Webhook successfully subscribed
Changes
No recorded changes to this operation across all 1 revision of this API.