---
updatedAt: 2026-09-30T22:12:05.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/linode-api/llms.txt
---

# Verify a webhook notification channel

Before you [create a notification channel](ref:post-notification-channel) that uses webhook as its `channel_type`, run this operation to verify your webhook configuration. If a request takes longer than two seconds to respond, it fails with an error.


**Permissions and scopes**

To call this operation, you need the following:

- **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth).

  - Scopes: `monitor:read_only`

# OpenAPI definition

```json
{
  "components": {
    "securitySchemes": {
      "oauth": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://login.linode.com/oauth/authorize",
            "scopes": {
              "account:read_only": "Allows access to GET information about your account.",
              "account:read_write": "Allows access to all endpoints related to your account.",
              "child_account:read_only": "Allows access to GET information about deprecated parent/child operations.",
              "child_account:read_write": "Allows access to deprecated parent/child operations.",
              "databases:read_only": "Allows access to GET information about databases.",
              "databases:read_write": "Allows access to all endpoints related to databases.",
              "domains:read_only": "Allows access to GET Domains on your account.",
              "domains:read_write": "Allows access to all Domain endpoints.",
              "events:read_only": "Allows access to GET your Events.",
              "events:read_write": "Allows access to all endpoints related to your Events.",
              "firewall:read_only": "Allows access to GET information about your Firewalls.",
              "firewall:read_write": "Allows access to all Firewall endpoints.",
              "images:read_only": "Allows access to GET your Images.",
              "images:read_write": "Allows access to all endpoints related to your Images.",
              "ips:read_only": "Allows access to GET your ips.",
              "ips:read_write": "Allows access to all endpoints related to your ips.",
              "linodes:read_only": "Allows access to GET Linodes on your account.",
              "linodes:read_write": "Allow access to all endpoints related to your Linodes.",
              "lke:read_only": "Allows access to GET LKE Clusters on your account.",
              "lke:read_write": "Allows access to all endpoints related to LKE Clusters on your account.",
              "longview:read_only": "Allows access to GET your Longview Clients.",
              "longview:read_write": "Allows access to all endpoints related to your Longview Clients.",
              "monitor:read_only": "Allows access to Monitor (Akamai Cloud Pulse) data.",
              "monitor:read_write": "Allows access to GET Monitor (Akamai Cloud Pulse) data.",
              "natgateways:read_only": "Allows access to Get NAT Gateways on your account.",
              "natgateways:read_write": "Allows access to all NAT Gateway endpoints.",
              "nodebalancers:read_only": "Allows access to GET NodeBalancers on your account.",
              "nodebalancers:read_write": "Allows access to all NodeBalancer endpoints.",
              "object_storage:read_only": "Allows access to GET information related to your Object Storage.",
              "object_storage:read_write": "Allows access to all Object Storage endpoints.",
              "stackscripts:read_only": "Allows access to GET your StackScripts.",
              "stackscripts:read_write": "Allows access to all endpoints related to your StackScripts.",
              "volumes:read_only": "Allows access to GET your Volumes.",
              "volumes:read_write": "Allows access to all endpoints related to your Volumes.",
              "vpc:read_write": "Allows access to all endpoints related to VPC and Subnet creation, updating, and deletion."
            },
            "tokenUrl": "https://login.linode.com/oauth/token"
          }
        },
        "type": "oauth2"
      },
      "personalAccessToken": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "externalDocs": {
    "description": "See documentation for Akamai's Linode API",
    "url": "https://techdocs.akamai.com/linode-api/reference"
  },
  "info": {
    "description": "\"[Read the API documentation](https://techdocs.akamai.com/linode-api/reference/api).\"",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Monitor",
    "version": "4.229.1"
  },
  "openapi": "3.0.1",
  "paths": {
    "/{apiVersion}/monitor/alert-channels/verify": {
      "post": {
        "description": "Before you [create a notification channel](ref:post-notification-channel) that uses webhook as its `channel_type`, run this operation to verify your webhook configuration. If a request takes longer than two seconds to respond, it fails with an error.\n\n\n**Permissions and scopes**\n\nTo call this operation, you need the following:\n\n- **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth).\n\n  - Scopes: `monitor:read_only`",
        "externalDocs": {
          "description": "See documentation for this operation in Akamai's Linode API",
          "url": "https://techdocs.akamai.com/linode-api/reference/verify-notification-channel"
        },
        "operationId": "verify-notification-channel",
        "requestBody": {
          "content": {
            "application/json": {
              "example": {
                "webhook": {
                  "authentication": {
                    "details": {
                      "basic_authentication_password": "C0mPl3X_p@$$w0Rd",
                      "basic_authentication_user": "John_Q"
                    },
                    "type": "basic"
                  },
                  "client_certification_details": {
                    "client_ca_certificate": "-----BEGIN CERTIFICATE-----\\aBCDEfgHIJ1klMnOPQrSTUvXYZA+bCdefGh ... IjKlmN2OPqRSTu\\vwx3y\\z-----END CERTIFICATE-----",
                    "client_certificate": "-----BEGIN CERTIFICATE-----\\aBCDEfgHIJ1klMnOPQrSTUvXYZA+bCdefGh ... IjKlmN2OPqRSTu\\vwx3y\\z-----END CERTIFICATE-----",
                    "client_private_key": "-----BEGIN CERTIFICATE-----\\aBCDEfgHIJ1klMnOPQrSTUvXYZA+bCdefGh ... IjKlmN2OPqRSTu\\vwx3y\\z-----END CERTIFICATE-----",
                    "tls_hostname": "my-site.com"
                  },
                  "custom_headers": [
                    {
                      "name": "Cache-Control",
                      "value": "max-age=0"
                    }
                  ],
                  "data_compression": "gzip",
                  "endpoint_url": "https://my-site.com/alerts-storage/basicAuth"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "webhook": {
                    "additionalProperties": false,
                    "description": "Input values for these fields to send a request to verify your webhook configuration.",
                    "properties": {
                      "authentication": {
                        "additionalProperties": false,
                        "description": "Authentication details required to access the `endpoint_url`.",
                        "properties": {
                          "details": {
                            "additionalProperties": false,
                            "description": "__Write-only__ Includes additional parameters necessary to define `basic` authentication. If `type` is set to `none`, leave this object empty or out of a request.",
                            "nullable": true,
                            "properties": {
                              "basic_authentication_password": {
                                "description": "The password tied to the `basic_authentication_user`, for `basic` authentication.",
                                "example": "C0mPl3X_p@$$w0Rd",
                                "type": "string"
                              },
                              "basic_authentication_user": {
                                "description": "The user name for `basic` authentication.",
                                "example": "John_Q",
                                "type": "string"
                              }
                            },
                            "required": [
                              "basic_authentication_user",
                              "basic_authentication_password"
                            ],
                            "type": "object",
                            "writeOnly": true
                          },
                          "type": {
                            "description": "The type of authentication in use. This can be `none` for no authentication, or `basic` for authentication using a username and password, set using the `details` parameters.",
                            "enum": [
                              "none",
                              "basic"
                            ],
                            "example": "basic",
                            "type": "string"
                          }
                        },
                        "required": [
                          "type"
                        ],
                        "type": "object"
                      },
                      "client_certification_details": {
                        "additionalProperties": false,
                        "description": "Contains mutual transport layer security (mTLS) client certificate information to additionally secure the connection for the request.\n\n> 📘\n>\n> This object only appears in a response to an operation if its `tls_hostname` object was set for the notification channel.",
                        "properties": {
                          "client_ca_certificate": {
                            "description": "The certificate authority (CA) certificate used to verify a requesting server's identity.",
                            "example": "-----BEGIN CERTIFICATE-----\\aBCDEfgHIJ1klMnOPQrSTUvXYZA+bCdefGh ... IjKlmN2OPqRSTu\\vwx3y\\z-----END CERTIFICATE-----",
                            "type": "string"
                          },
                          "client_certificate": {
                            "description": "The PEM-formatted digital certificate you want to authenticate requests to the `endpoint_url`.",
                            "example": "-----BEGIN CERTIFICATE-----\\aBCDEfgHIJ1klMnOPQrSTUvXYZA+bCdefGh ... IjKlmN2OPqRSTu\\vwx3y\\z-----END CERTIFICATE-----",
                            "type": "string"
                          },
                          "client_private_key": {
                            "description": "__Write-only__ The private key in the non-encrypted PKCS8 format that authenticates with the back-end server.\n\n> 📘\n>\n> For security purposes, this field is hidden from the response for all operations.",
                            "example": "-----BEGIN CERTIFICATE-----\\aBCDEfgHIJ1klMnOPQrSTUvXYZA+bCdefGh ... IjKlmN2OPqRSTu\\vwx3y\\z-----END CERTIFICATE-----",
                            "type": "string",
                            "writeOnly": true
                          },
                          "tls_hostname": {
                            "description": "For mTLS support, this is the hostname that verifies the server's certificate and matches the Subject Alternative Names (SANs) in the certificate. If this field is left out, the API fetches the hostname from the `endpoint_url`.",
                            "example": "my-site.com",
                            "type": "string"
                          }
                        },
                        "required": [
                          "client_ca_certificate",
                          "client_certificate",
                          "client_private_key"
                        ],
                        "type": "object"
                      },
                      "custom_headers": {
                        "description": "Custom headers to add to the request. You can use custom headers as additional validation to inform your webhook server that an alert notification comes from a valid source. To set up this authenticity validation, pass a secret value in a custom header and then check it against an expected value. \n\n> 📘\n>\n> These headers are _not_ supported:\n>\n> - Akamai\n> - Authorization\n> - Connection\n> - Content-Type\n> - Content-Length\n> - Cookie\n> - Encoding\n> - Expect\n> - Host\n> - Set-Cookie\n> - Transfer-Encoding\n> - Upgrade",
                        "items": {
                          "additionalProperties": false,
                          "properties": {
                            "name": {
                              "description": "The name of the custom header to include in the request.",
                              "example": "Cache-Control",
                              "type": "string"
                            },
                            "value": {
                              "description": "The custom header's value to include in the request.",
                              "example": "max-age=0",
                              "type": "string"
                            }
                          },
                          "required": [
                            "name",
                            "value"
                          ],
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "data_compression": {
                        "description": "Specifies whether data compression is applied to files included in a request. This can be `gzip` to apply this compression format or `none`.",
                        "enum": [
                          "gzip",
                          "none"
                        ],
                        "example": "gzip",
                        "type": "string"
                      },
                      "endpoint_url": {
                        "description": "The URL where the request will be sent for the webhook.\n\n> 📘\n>\n> Requests to the `endpoint_url` need to use a content-type of `application/json`. All other format requests return an error.",
                        "example": "https://my-site.com/alerts-storage/basicAuth",
                        "type": "string"
                      }
                    },
                    "required": [
                      "endpoint_url",
                      "authentication"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "webhook"
                ],
                "type": "object",
                "x-akamai": {
                  "file-path": "schemas/aclp-notification-channel-verify-request.yaml"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "webhook": {
                    "http_status": 200,
                    "response": "OK"
                  }
                },
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "webhook": {
                      "additionalProperties": false,
                      "description": "Information returned after a request to your webhook configuration.\n\n* `200 - OK`. Completed successfully, based on the settings you applied in the request.\n* `400 - Bad Request`. The webhook channel doesn't exist. Verify the `endpoint_url`.\n* `401 - Unauthorized`. Authentication failed. Check `authentication` and `client_certificate_details` settings.\n* `404 - Not Found`. The connection to the webhook channel failed. Check all settings in the request.\n* `504 - Internal Error`. The request timed out after two seconds. Verify the request settings and try again.",
                      "properties": {
                        "http_status": {
                          "description": "The HTTP status code for the response.",
                          "example": 200,
                          "type": "integer"
                        },
                        "response": {
                          "description": "The result of the request.",
                          "example": "OK",
                          "type": "string"
                        }
                      },
                      "type": "object"
                    }
                  },
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/aclp-notification-channel-verify-response.yaml"
                  }
                }
              }
            },
            "description": "A notification channel was created."
          },
          "default": {
            "content": {
              "application/json": {
                "example": {
                  "errors": [
                    {
                      "reason": "Invalid JSON"
                    }
                  ]
                },
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "errors": {
                      "description": "Any warnings associated with a response.",
                      "items": {
                        "additionalProperties": false,
                        "description": "An object for describing a single error that occurred during the processing of a request.",
                        "properties": {
                          "field": {
                            "description": "The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request.",
                            "example": "fieldname",
                            "type": "string"
                          },
                          "reason": {
                            "description": "What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](ref:post-ticket) or perform some other action before you can complete the request successfully.",
                            "example": "fieldname must be a valid value",
                            "type": "string"
                          }
                        },
                        "type": "object",
                        "x-akamai": {
                          "file-path": "schemas/error-object.yaml"
                        }
                      },
                      "type": "array"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "See [Errors](ref:errors) for the range of possible error response codes."
          }
        },
        "security": [
          {
            "personalAccessToken": []
          },
          {
            "oauth": [
              "monitor:read_only"
            ]
          }
        ],
        "summary": "Verify a webhook notification channel",
        "tags": [
          "Alerts"
        ],
        "x-linode-cli-skip": true
      },
      "parameters": [
        {
          "description": "__Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.",
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "enum": [
              "v4",
              "v4beta"
            ],
            "example": "v4",
            "type": "string"
          },
          "x-akamai": {
            "file-path": "parameters/api-version-path.yaml"
          }
        }
      ],
      "x-akamai": {
        "file-path": "paths/aclp-notification-channel-verify.yaml",
        "path-info": "/{apiVersion}/monitor/alert-channels/verify"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.linode.com"
    }
  ],
  "tags": [
    {
      "description": "Akamai Cloud Pulse lets you configure alerts to monitor key metrics and events in real time and automatically trigger notifications or actions when predefined thresholds or conditions are met.",
      "name": "Alerts"
    }
  ],
  "x-akamai": {
    "auth-type": "OAUTH",
    "file-path": "monitor-1.yaml"
  },
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "python",
      "node"
    ]
  }
}
```

# Sibling pages

* [Create an alert definition](https://techdocs.akamai.com/linode-api/reference/post-alert-definition-for-service-type.md)
* [List alert definitions](https://techdocs.akamai.com/linode-api/reference/get-alert-definitions.md)
* [Get an alert definition](https://techdocs.akamai.com/linode-api/reference/get-alert-definition.md)
* [Update an alert definition](https://techdocs.akamai.com/linode-api/reference/put-alert-definition.md)
* [Clone an alert definition](https://techdocs.akamai.com/linode-api/reference/post-clone-alert-definition.md)
* [List alert definitions for a service type](https://techdocs.akamai.com/linode-api/reference/get-alert-definitions-for-service-type.md)
* [List entities assigned to an alert definition](https://techdocs.akamai.com/linode-api/reference/get-alert-definition-entities.md)
* [Delete an alert definition](https://techdocs.akamai.com/linode-api/reference/delete-alert-definition.md)
* [Create a notification channel](https://techdocs.akamai.com/linode-api/reference/post-notification-channel.md)
* [List notification channels](https://techdocs.akamai.com/linode-api/reference/get-notification-channels.md)
* [Get a notification channel](https://techdocs.akamai.com/linode-api/reference/get-notification-channel.md)
* [Update a notification channel](https://techdocs.akamai.com/linode-api/reference/put-notification-channel.md)
* [List alerts for a notification channel](https://techdocs.akamai.com/linode-api/reference/get-notification-channel-alerts.md)
* [Delete a notification channel](https://techdocs.akamai.com/linode-api/reference/delete-notification-channel.md)