Skip to main content
POST
/
v1
/
webhooks
/
messages
Create a new webhook for messages
curl --request POST \
  --url https://api.openphone.com/v1/webhooks/messages \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "message.received"
  ],
  "url": "<string>",
  "label": "<string>",
  "resourceIds": [
    "<string>"
  ],
  "status": "enabled",
  "userId": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "userId": "<string>",
    "orgId": "<string>",
    "label": "my webhook label",
    "status": "enabled",
    "url": "<string>",
    "key": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2022-01-01T00:00:00Z",
    "events": [
      "message.received"
    ],
    "resourceIds": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
events
enum<string>[]
required
Available options:
message.received,
message.delivered
​
url
string<uri>
required

The endpoint that receives events from the webhook.

Example:

"https://example.com"

​
label
string

Webhook's label

Example:

"my webhook label"

​
resourceIds
Pattern: ^PN(.*)$
​
status
enum<string>
default:enabled

The status of the webhook.

Available options:
enabled,
disabled
Example:

"enabled"

​
userId
string

The unique identifier of the user that creates the webhook. If not provided, default to workspace owner.

Pattern: ^US(.*)$
Example:

"US123abc"

Response

Success

​
data
object
required