@font-face {
  font-family: "Roobert";
  src: url("https://uploads-ssl.webflow.com/6384fdd9fd42380b529fc942/646dce023a43d52740e2f3c8_Roobert-SemiBold.ttf");
  font-weight: 600;
  font-style: normal;
}

@font-face {
  font-family: "Roobert";
  src: url("https://uploads-ssl.webflow.com/6384fdd9fd42380b529fc942/646dce02a844c04f2faca171_Roobert-Medium.ttf");
  font-weight: 500;
  font-style: normal;
}

h1,
h2,
h3 {
  font-family: "Roobert", sans-serif;
}

strong {
  color: inherit !important;
}

#topbar-cta-button {
  height: 36px;
}

#topbar-cta-button > a > span {
  background-color: #6439f5;
  border-radius: 10px;
}

#topbar-cta-button > a > div span,
#topbar-cta-button > a > div svg {
  color: white;
}


Creates a new webhook that triggers on events from messages.

Create a new webhook for messages

apiKey

OpenPhone Docs

Introduction

Authentication

This is a step-by-step guide for sending your first text message.

Send your first message

OpenPhone uses standard HTTP response codes to indicate request status. 

API response codes

Stay up to date with the latest improvements to the API.

Changelog

OpenPhone implements rate limiting to ensure API stability and fair usage.

Rate limits

Fetch a paginated list of calls associated with a specific OpenPhone number and another number.

List calls

Retrieve a list of recordings associated with a specific call. The results are sorted chronologically, with the oldest recording segment appearing first in the list.

Get recordings for a call

Retrieve an AI-generated summary of a specific call identified by its unique call ID. Call summaries are only available on OpenPhone Business plan.

Get a summary for a call

Retrieve a detailed transcript of a specific call identified by its unique call ID. Call transcripts are only available on OpenPhone business plan.

Get a transcription for a call

Custom contact fields enhance your OpenPhone contacts with additional information beyond standard details like name, company, role, emails and phone numbers. These user-defined fields let you capture business-specific data. While you can only create or modify these fields in OpenPhone itself, this endpoint retrieves your existing custom properties. Use this information to accurately map and include important custom data when creating new contacts via the API.

Get contact custom fields

Retrieve a paginated list of contacts associated with specific external IDs. You can optionally filter the results further by providing a list of sources. **Note**: The `externalIds` parameter is currently required to specify the contacts you want to retrieve.

List contacts

Create a contact

Retrieve detailed information about a specific contact in your OpenPhone workspace using the contact's unique identifier.

Get a contact by ID

Delete a contact by its unique identifier.

Delete a contact

Modify an existing contact in your OpenPhone workspace using the contact's unique identifier.

Update a contact by ID

Fetch a paginated list of conversations of OpenPhone conversations. Can be filtered by user and/or phone numbers. Defaults to all conversations in the OpenPhone organization. Results are returned in descending order based on the most recent conversation.

List Conversations

Retrieve a chronological list of messages exchanged between your OpenPhone number and specified participants, with support for filtering and pagination. 

List messages

Send a text message from your OpenPhone number to a recipient.

Send a text message

Get a message by ID

Retrieve the list of phone numbers and users associated with your OpenPhone workspace.

List phone numbers

Lists all webhooks

Get a webhook by ID

Delete a webhook by its unique identifier.

Delete a webhook by ID

Creates a new webhook that triggers on events from calls.

Create a new webhook for calls

Creates a new webhook that triggers on events from call summaries.

Create a new webhook for call summaries

Creates a new webhook that triggers on events from call transcripts.

Create a new webhook for call transcripts

Learn more about working with contacts via the OpenPhone API.

Integration contacts

A reference for API-generated webhook payloads.

Webhooks

Learn how to use AI Language Models to build applications with the OpenPhone API.

Building with AI LLMs

Implement a one-way contact sync from Google Sheets to OpenPhone using Javascript.

Sync your contacts

Welcome to OpenPhone's simple and transparent API pricing structure.

Pricing overview

We’ve provided the below tips to help you minimize segment counts and save money.

Getting started

Essentials

Calls

Contact Custom Fields

Contacts

Conversations

Messages

Phone Numbers

Webhooks

Create a new webhook for messages

Authorizations

Body

Response