Era.Common.DataDefinition.Task.Server.SendWebhook

Description

Definition of webhook message part

Properties

Name	JsonSchemaType	Description
json_body	string	JSON body of CUSTOM webhook POST request (undefined otherwise).
url	string	URL addres of webhook POST request
variables	reference to Era.Common.DataDefinition.Task.Server.SendWebhook_Variables	Customize content of webhoook with variables.
webhook_type	enum of Era.Common.DataDefinition.Task.Server.SendWebhook_WebhookType	Type of incoming webhook application

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Task.Server.SendNotification

JsonSchema

{
    "title": "Era.Common.DataDefinition.Task.Server.SendWebhook",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Task.Server.SendWebhook"
    ],
    "properties": {
        "Era.Common.DataDefinition.Task.Server.SendWebhook": {
            "$ref": "#/definitions/SendWebhook"
        }
    },
    "definitions": {
        "SendWebhook": {
            "additionalProperties": false,
            "required": [
                "url",
                "variables",
                "webhook_type"
            ],
            "type": "object",
            "properties": {
                "json_body": {
                    "type": "string"
                },
                "url": {
                    "type": "string"
                },
                "variables": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.SendWebhook_Variables#/definitions/SendWebhook_Variables"
                },
                "webhook_type": {
                    "enum": [
                        0,
                        1,
                        2
                    ]
                }
            }
        }
    }
}