Overview
This node allows you to interact with the OpenPhone API, specifically to create a webhook subscription. When creating a webhook, you provide a URL endpoint and specify which events you want to subscribe to. The node then registers this webhook with OpenPhone so that your specified URL will receive notifications when those events occur.
Common scenarios include:
- Automatically triggering workflows in n8n when a new message is received or delivered.
- Reacting to call events such as call started or completed.
- Integrating OpenPhone event notifications into other systems via webhooks.
For example, you might create a webhook to notify your CRM system whenever a message is received on your OpenPhone number, enabling real-time updates of customer interactions.
Properties
| Name | Meaning |
|---|---|
| URL | The webhook endpoint URL where OpenPhone will send event notifications. |
| Events | The list of events to subscribe to. Options: "Message Received", "Message Delivered", "Message Updated", "Call Completed", "Call Started". |
Output
The node outputs an array of JSON objects representing the response from the OpenPhone API after creating the webhook. The JSON typically contains details about the created webhook, including its ID, subscribed events, and the registered URL.
No binary data output is produced by this operation.
Example output JSON structure (simplified):
{
"id": "webhook_id",
"url": "https://your-domain.com/webhook",
"events": [
"message.received",
"call.completed"
],
"createdAt": "2024-01-01T00:00:00Z"
}
Dependencies
- Requires an API key credential for authenticating with the OpenPhone API.
- The node makes HTTP requests to
https://api.openphone.com/v1/webhooks. - Ensure your n8n instance has internet access to reach the OpenPhone API.
- The webhook URL you provide must be publicly accessible to receive event callbacks.
Troubleshooting
- Invalid URL or unreachable webhook endpoint: If the provided URL is not reachable or invalid, the webhook creation may fail or events will not be delivered. Verify the URL is correct and publicly accessible.
- Authentication errors: If the API key credential is missing or incorrect, the node will return authentication errors. Make sure the API key is valid and properly configured.
- Event subscription issues: Subscribing to unsupported or misspelled events will cause errors. Use only the listed event options.
- API rate limits: Excessive webhook creations or API calls may hit rate limits imposed by OpenPhone. Check OpenPhone's API documentation for limits and retry policies.
- Error messages: The node throws errors with messages returned from the OpenPhone API. Review these messages to identify issues such as invalid parameters or permission problems.