Subscribe to Webhooks

post

https://api.yelp.com/v3/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.

Responses

code	description
UNAUTHORIZED_API_KEY	The API key provided is not currently able to query this endpoint.
TOKEN_INVALID	Invalid API key or authorization header.

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 OK - Webhook successfully subscribed

400Bad Request

401The API key has either expired or doesn't have the required scopes to query this endpoint. codedescriptionUNAUTHORIZED_API_KEYThe API key provided is not currently able to query this endpoint.TOKEN_INVALIDInvalid API key or authorization header.

409Conflict

429You have either exceeded your daily quota, or have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries.

500Internal Server Error