Webhooks
Lists all webhooks
Getting started
Essentials
Calls
Contact Custom Fields
Contacts
Conversations
Phone Numbers
Webhooks
Lists all webhooks
List all webhooks for a user.
GET
/
v1
/
webhooks
curl --request GET \
--url https://api.openphone.com/v1/webhooks \
--header 'Authorization: <api-key>'{
"data": [
{
"id": "WHabcd1234",
"userId": "US123abc",
"orgId": "OR1223abc",
"label": "my webhook label",
"status": "enabled",
"url": "https://example.com/",
"key": "example-key",
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"deletedAt": "2022-01-01T00:00:00Z",
"events": [
"message.received"
],
"resourceIds": [
"<string>"
]
}
]
}Authorizations
Query Parameters
The unique identifier the user. Defaults to the workspace owner.
Example:
"U"
Response
200
application/json
Success
The webhook's ID
Example:
"WHabcd1234"
The unique identifier of the user that created the webhook.
Example:
"US123abc"
The unique identifier of the organization the webhook belongs to
Example:
"OR1223abc"
The webhook's label.
Example:
"my webhook label"
The status of the webhook.
Available options:
enabled, disabled Example:
"enabled"
The endpoint that receives events from the webhook.
Example:
"https://example.com/"
Webhook key
Example:
"example-key"
The date the webhook was created at, in ISO_8601 format.
Example:
"2022-01-01T00:00:00Z"
The date the webhook was created at, in ISO_8601 format.
Example:
"2022-01-01T00:00:00Z"
The date the webhook was deleted at, in ISO_8601 format.
Example:
"2022-01-01T00:00:00Z"
Available options:
message.received, message.delivered Was this page helpful?
curl --request GET \
--url https://api.openphone.com/v1/webhooks \
--header 'Authorization: <api-key>'{
"data": [
{
"id": "WHabcd1234",
"userId": "US123abc",
"orgId": "OR1223abc",
"label": "my webhook label",
"status": "enabled",
"url": "https://example.com/",
"key": "example-key",
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"deletedAt": "2022-01-01T00:00:00Z",
"events": [
"message.received"
],
"resourceIds": [
"<string>"
]
}
]
}