API Documentation

Use the Hooksbase API reference to explore request patterns, response shapes, authentication flows, and webhook integration examples for your product.

Quickstart Explore SDKs

Getting started

To get started, create a project in the Hooksbase dashboard, then read about how to make requests for the resources you need to access using our HTTP APIs and client examples. When your integration is ready to go live, you can return to the dashboard to configure the next layer of webhooks, auth, and delivery controls.

Get your API key

Guides

Authentication

Learn how to authenticate your API requests.

Pagination

Understand how to work with paginated responses.

Errors

Read about the different types of errors returned by the API.

Webhooks

Learn how to programmatically configure webhooks for your app.

Resources

Contacts

Learn about the contact model and how to create, retrieve, update, delete, and list contacts.

Conversations

Learn about the conversation model and how to create, retrieve, update, delete, and list conversations.

Messages

Learn about the message model and how to create, retrieve, update, delete, and list messages.

Groups

Learn about the group model and how to create, retrieve, update, delete, and list groups.