| Field | Required | Accessor | Description |
|---|---|---|---|
| name | — | Name | |
| payload_url | — | This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body. | |
| http_method | — | HTTP method | |
| http_content_type | — | The complete list of official content types is available <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">here</a>. | |
| additional_headers | — | — | User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format <code>Name: Value</code>. Jinja2 template processing is supported with the same context as the request body (below). |
| body_template | — | — | Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: <code>event</code>, <code>model</code>, <code>timestamp</code>, <code>username</code>, <code>request_id</code>, and <code>data</code>. |
| secret | — | — | When provided, the request will include a <code>X-Hook-Signature</code> header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request. |
| ssl_verification | — | — |
Enable SSL certificate verification. Disable with caution!
Specify true or false |
| ca_file_path | — | — | The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults. |
| description | — | — | Description |
| tags | — | slug | Tag slugs separated by commas, encased with double quotes (e.g. "tag1,tag2,tag3") |
| id | — | — | Numeric ID of an existing object to update (if not creating a new object) |
Required fields must be specified for all objects.
Related objects may be referenced by any unique attribute. For example, vrf.rd would identify a VRF by its route distinguisher.