Overview
Getting Started
Widgets
Categories
Keywords
Reviews
Users
Businesses
Businesses Search
Negotiations
Messages
Requests
Help
Changelog
Terms and Policies
The Business APIs support two different groups of behaviors: general purpose Business operations and Business Webhook related operations.
More technical details regarding general purpose Business operations can be seen in the Businesses API.
GET /api/v4/businesses HTTP/2authorization: Bearer {{authCode}}
{"data": [{"businessID": "1337","name": "Robert's Aerial Photography","imageURL": "https://production-next-images-cdn.thumbtack.com/i/323302111019294847/desktop/standard/fullscreen"}],"pagination": {"limit": 20}}
More technical details regarding Business Webhook related operations can be seen in the Business Webhook API. Below, we illustrate an example.
For the below examples, you can leverage https://webhook.site to test out the webhook behavior.
The below command creates a disabled webhook which listens for MessageCreated and NegotationCreated Events.
POST /api/v4/businesses/{{businessID}}/webhooks HTTP/2authorization: Bearer {{authCode}}content-type: application/json{"webhookURL": "<your webhook URL>","eventTypes": ["MessageCreatedV4","NegotiationCreatedV4"],"enabled": false,"auth": {"username": "hello","password": "world"}}
{"webhookID": "<your unique webhookID>","webhookURL": "<your webhook URL>","enabled": false,"authType": "Basic","businessID": "<the businessID>","eventTypes": ["MessageCreatedV4","NegotationCreatedV4"]}
We can fetch this Webhook's data directly, as such:
GET /api/v4/businesses/{{businessID}}/webhooks/{{webhookID}} HTTP/2authorization: Bearer {{authCode}}
{"webhookID": "<your webhookID>","webhookURL": "<your webhook.site URL>","enabled": false,"authType": "Basic","businessID": "<the businessID>","eventTypes": ["MessageCreatedV4","NegotationCreatedV4"]}
Alternatively, we can fetch all Webhooks for the given Business.
GET /api/v4/businesses/{{businessID}}/webhooks HTTP/2authorization: Bearer {{authCode}}
{"data": [{...webhook fields},...],"pagination": {"limit": 10}}
We can enable the webhook by:
PUT /api/v4/businesses/{{businessID}}/webhooks/{{webhookID}} HTTP/2authorization: Bearer {{authCode}}content-type: application/json{"enabled": true}
We can modify the Webhook's authentication by:
PUT /api/v4/businesses/{{businessID}}/webhooks/{{webhookID}}/auth HTTP/2authorization: Bearer {{authCode}}content-type: application/json{"username": "username","password": "password"}
We can delete the Webhook's authentication by:
DELETE /api/v4/businesses/{{businessID}}/webhooks/{{webhookID}}/auth HTTP/2authorization: Bearer {{authCode}}
DELETE /api/v4/businesses/{{businessID}}/webhooks/{{webhookID}} HTTP/2authorization: Bearer {{authCode}}
On this page