Skip to main content

Connections

webhook

Commentary​

added in 0.0.5

Connects to a webhook, sending data with POST. dataShape must be specified so that generators will conform to a known schema.

Examples​

Configuring the connection​

{
    "connections": {
        "saas-webhook": {
            "kind": "webhook",
            "dataShape": "kafka",
            "httpConfigs": {
                "url": "https://my-site/webhook-endpoint"
            }
        }
    }
}

Specification​

Connection JSON schema​

{
    "type": "object",
    "properties": {
        "kind": {
            "type": "string",
            "const": "webhook"
        },
        "dataShape": {
            "type": "string",
            "enum": [
                "kafka",
                "postgres"
            ]
        },
        "bodyFormat": {
            "type": "string",
            "enum": [
                "decodable"
            ]
        },
        "httpConfigs": {
            "type": "object",
            "properties": {
                "url": {
                    "type": "string"
                }
            },
            "required": [
                "url"
            ]
        }
    },
    "required": [
        "dataShape",
        "httpConfigs"
    ]
}