Webhooks
Lists all webhooks
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{
"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": [
"PN1234"
]
}
]
}Query Parameters
The unique identifier the user. Defaults to the workspace owner.
Response
200
application/json
Success
The webhook's ID
The unique identifier of the user that created the webhook.
The unique identifier of the organization the webhook belongs to
The webhook's label.
The status of the webhook.
Available options:
enabled, disabled The endpoint that receives events from the webhook.
Webhook key
The date the webhook was created at, in ISO_8601 format.
The date the webhook was created at, in ISO_8601 format.
The date the webhook was deleted at, in ISO_8601 format.
The event associated with the webhook.
Available options:
message.received, message.delivered The unique identifiers of the phone numbers associated with the webhook.
Was this page helpful?
curl --request GET \
--url https://api.openphone.com/v1/webhooks{
"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": [
"PN1234"
]
}
]
}