Lists all webhooks

List all webhooks for a user.

GET /v1/webhooks

Lists all webhooks

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/v1/webhooks \
  --header 'Authorization: <api-key>'

200

{
  "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": [],
      "resourceIds": [
        "PN1234"
      ]
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Query Parameters

userId · string

The unique identifier the user. Defaults to the workspace owner.

Pattern: ^US(.*)$

Example:

"U55wgP5I5"

Response

200

application/json

OK

data · object[] · required

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes