[ Web Proxy ]
URL:
Viewing: https://developers.cloudflare.com/api/resources/stream/subresources/webhooks/methods/get [Back]  [Original]
View webhooks | Cloudflare API Skip to content
logo.DMYpXs3t.svg [logo.DMYpXs3t.svg] Cloudflare API
CtrlK
Start here
Start here
HTTP
API Reference
Stream
Webhooks
Copy Markdown

View webhooks

GET/accounts/{account_id}/stream/webhook

Retrieves a list of webhooks.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Stream WriteStream Read
Path ParametersExpand Collapse
account_id: string

The account identifier tag.

maxLength32
ReturnsExpand Collapse
errors: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Whether the API call was successful.

result: optional object { modified, notification_url, notificationUrl, secret }
modified: optional string

The date and time the webhook was last modified.

formatdate-time
notification_url: optional string

The URL where webhooks will be sent.

formaturi
notificationUrl: optional string

The URL where webhooks will be sent.

formaturi
secret: optional string

The secret used to verify webhook signatures.

View webhooks

HTTP
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/stream/webhook \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
200 example
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "modified": "2014-01-02T02:20:00Z",
    "notification_url": "https://example.com",
    "notificationUrl": "https://example.com",
    "secret": "secret"
  }
}
Returns Examples
200 example
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "modified": "2014-01-02T02:20:00Z",
    "notification_url": "https://example.com",
    "notificationUrl": "https://example.com",
    "secret": "secret"
  }
}
Web Proxy Viewer  |  New URL  |  Original Page