The linkout attribution endpoint allows you to connect Yelp events, with relevant events of your service.

Example

If you provide a booking service and are partnered with Yelp, we will send a linkout URL on business booking events.
The linkout URL will look like: https://partner.example.com/book?yelp_token=abcd-1234

You will need to store the provided token for 30 days so it can be linked to further updates.

Then, to update the status of the booking event, send a POST request with a 'booking' vertical echoing the yelp token from the linkout, like so:

Endpoint: https://api.yelp.com/v3/webhooks/conversions/booking
Body:

{
    "yelp_token": "abcd-1234",
    "event_type": "confirmed",
    "event_timestamp": 1774619463560,
    "external_id": "123456789",
    "original_external_id": "1234567890",
    "booking_details_url": "https://partner.example.com/appointments/123456789",
    "booked_services": [
        {
            "title": "Haircut and Style",
            "provider": "Mike's Salon",
            "duration_minutes": 60,
            "start_datetime": "1774619463560",
            "order_value": {
                "price": 90.0,
                "currency": "USD"
            }
        },
    ]
}

A success will return an empty 200 response.

Note: The format for the authorization header is "Bearer <API_KEY>", i.e. for curl -H Authorization: Bearer <API_KEY>. For details see Authentication