launchdarkly · Schema

Webhook

A webhook configuration for receiving change notifications.

Properties

Name Type Description
_id string The unique identifier of this webhook.
url string The URL to receive webhook POST requests.
secret string The shared secret used to sign webhook payloads.
true boolean Whether this webhook is currently enabled.
name string The human-readable name of this webhook.
tags array Tags applied to this webhook.
statements array Policy statements filtering which events trigger this webhook.
_links object
View JSON Schema on GitHub

JSON Schema

launchdarkly-webhook-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Webhook",
  "title": "Webhook",
  "type": "object",
  "description": "A webhook configuration for receiving change notifications.",
  "properties": {
    "_id": {
      "type": "string",
      "description": "The unique identifier of this webhook."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL to receive webhook POST requests."
    },
    "secret": {
      "type": "string",
      "description": "The shared secret used to sign webhook payloads."
    },
    "true": {
      "type": "boolean",
      "description": "Whether this webhook is currently enabled."
    },
    "name": {
      "type": "string",
      "description": "The human-readable name of this webhook."
    },
    "tags": {
      "type": "array",
      "description": "Tags applied to this webhook.",
      "items": {
        "type": "string"
      }
    },
    "statements": {
      "type": "array",
      "description": "Policy statements filtering which events trigger this webhook.",
      "items": {
        "$ref": "#/components/schemas/Statement"
      }
    },
    "_links": {
      "$ref": "#/components/schemas/Links"
    }
  }
}