v1

latestOpenAPI 3.1.02026-07-248941352.6 KB
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/

Response

200 OK - Webhook successfully subscribed

webhook_idstring

The unique identifier for the webhook subscription.

expiration_datestring

The date and time when the webhook subscription will expire. (ISO 8601 format)