Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 2.68 KB

Webhook.md

File metadata and controls

30 lines (25 loc) · 2.68 KB

Webhook

Properties

Name Type Description Notes
id Option<i32> [optional][readonly]
url Option<String> [optional][readonly]
display Option<String> [optional][readonly]
content_types Vec
name String
type_create Option<bool> Call this webhook when a matching object is created. [optional]
type_update Option<bool> Call this webhook when a matching object is updated. [optional]
type_delete Option<bool> Call this webhook when a matching object is deleted. [optional]
payload_url String 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.
enabled Option<bool> [optional]
http_method Option<String> [optional]
http_content_type Option<String> The complete list of official content types is available <a href="https://www.iana.org/assignments/media-types/media-types.xhtml\">here. [optional]
additional_headers Option<String> User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below). [optional]
body_template Option<String> Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data. [optional]
secret Option<String> When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request. [optional]
conditions Option<serde_json::Value> A set of conditions which determine whether the webhook will be generated. [optional]
ssl_verification Option<bool> Enable SSL certificate verification. Disable with caution! [optional]
ca_file_path Option<String> The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults. [optional]
created Option<String> [optional][readonly]
last_updated Option<String> [optional][readonly]

[Back to Model list] [Back to API list] [Back to README]