Webhooks Resource

Description

This resource is for listing webhooks or creating new ones.

GET /webhooks

Get the full list of configured webhooks.

GET Response Values

Each data element will be a full webhook resource object.

Example GET request

GET /webooks

Example GET response

[
	{
		"resource": "/webhooks/9",
		"job_resource": "/webhooks/9/webhook_jobs",
		"clear_job_resource": "/webhooks/9/webhook_jobs/clear",
		"download_job_resource": "/webhooks/9/webhook_jobs/download",
		"test_resource": "/webhooks/9/test",
		"url": "https://example.com",
		"name": "Example",
		"enabled": false,
		"verify_ssl": true,
		"header": [],
		"secret": "",
		"timeout": 0,
		"events": [
			"group"
		]
	}
 ]

POST /webhooks

Create a new webhook.

POST JSON Body

Name	Required	Type	Description	Default Value
url	Yes	String
name	Yes	String	Must be unique
header	No	Array[Header]	Use [] if no headers need to be sent. See below.
events	No	Array[String]	Events to generate messages for. See below.
enabled	No	Boolean		True
timeout	No	Integer	Hours to retain failed messages	0
secret	No	String	Key for x-rweb-sig header	""
verify_ssl	No	Boolean		True

Events field

Current set of valid events:

• "zone"
• "test"
• "user"
• "role"
• "zone-config"
• "zone-prefix"
• "block-list"
• "source-allow-list"
• "destination-allow-list"
• "group"
• "group-config"
• "template"
• "report"
• "scheduled-report"
• "victim"

Header field

Describes HTTP headers that should be sent with each request. Keys and Values must be valid HTTP Use this format:

{
  "header": [
    {"key": "HeaderKey", "value": "HeaderValue"},
  ]
}

Example POST Request

POST /webhooks

{"data":{
	"name": "Example Webhook",
	"url": "https://example.com",
	"events": ["zone"],
	"header": [],
	"enabled": false
}}

Example POST Response

HTTP/1.1 201 Created

{
	"resource": "/webhooks/9",
	"job_resource": "/webhooks/9/webhook_jobs",
	"clear_job_resource": "/webhooks/9/webhook_jobs/clear",
	"download_job_resource": "/webhooks/9/webhook_jobs/download",
	"test_resource": "/webhooks/9/test",
	"url": "https://example.com",
	"name": "Example Webhook",
	"enabled": false,
	"verify_ssl": true,
	"header": [],
	"secret": "",
	"timeout": 0,
	"events": [
		"zone"
	]
}