Gets a list of all configured webhook destinations.
/accounts/{account_id}/alerting/v3/destinations/webhooks
get
Notification webhooks
notification-webhooks-list-webhooks
{
"business": true,
"enterprise": true,
"free": false,
"pro": true
}null[
{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"description": "The account id",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"created_at": {
"description": "Timestamp of when the webhook destination was created.",
"example": "2020-10-26T18:25:04.532316Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The unique identifier of a webhook",
"example": "b115d5ec-15c6-41ee-8b76-92c449b5227b",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"last_failure": {
"description": "Timestamp of the last time an attempt to dispatch a notification to this webhook failed.",
"example": "2020-10-26T18:25:04.532316Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"last_success": {
"description": "Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.",
"example": "2020-10-26T18:25:04.532316Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the webhook destination. This will be included in the request body when you receive a webhook notification.",
"example": "Slack Webhook",
"type": "string"
},
"secret": {
"description": "Optional secret that will be passed in the `cf-webhook-auth` header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body.",
"type": "string"
},
"type": {
"description": "Type of webhook endpoint.",
"enum": [
"slack",
"generic",
"gchat"
],
"example": "slack",
"type": "string"
},
"url": {
"description": "The POST endpoint to call when dispatching a notification.",
"example": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List webhooks response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"created_at": {
"description": "Timestamp of when the webhook destination was created.",
"example": "2020-10-26T18:25:04.532316Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The unique identifier of a webhook",
"example": "b115d5ec-15c6-41ee-8b76-92c449b5227b",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"last_failure": {
"description": "Timestamp of the last time an attempt to dispatch a notification to this webhook failed.",
"example": "2020-10-26T18:25:04.532316Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"last_success": {
"description": "Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.",
"example": "2020-10-26T18:25:04.532316Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the webhook destination. This will be included in the request body when you receive a webhook notification.",
"example": "Slack Webhook",
"type": "string"
},
"secret": {
"description": "Optional secret that will be passed in the `cf-webhook-auth` header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body.",
"type": "string"
},
"type": {
"description": "Type of webhook endpoint.",
"enum": [
"slack",
"generic",
"gchat"
],
"example": "slack",
"type": "string"
},
"url": {
"description": "The POST endpoint to call when dispatching a notification.",
"example": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List webhooks response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]