Configuring your connectionsConnection configurations

Webhook

Supports:

  • ✅ Model sync destination

Connection

Configuration

NameTypeDescriptionRequired
auth_methodstringAuthentication method

Accepted values: polytomic_secret, basic ↓, header ↓, query ↓, oauth_client_credentials ↓		true
headersarrayAdditional headersfalse
urlstringWebhook URLtrue

auth_method

When auth_method is basic
NameTypeDescriptionRequired
basicobjectBasic authenticationtrue
When auth_method is header
NameTypeDescriptionRequired
headerobjectHeadertrue
When auth_method is oauth_client_credentials
NameTypeDescriptionRequired
oauthobjectOAuth client credentialstrue
When auth_method is query
NameTypeDescriptionRequired
queryarrayQuery string authentication parameterstrue

Example

{
  "name": "Webhook connection",
  "type": "webhook",
  "configuration": {
    "auth_method": "",
    "headers": [
        {
            "name": "foo",
            "value": "bar"
        }
    ],
    "url": "https://example.com/webhook"
  }
}

Read-only properties

NameTypeDescriptionRequired

auth_method

When auth_method is polytomic_secret
NameTypeDescriptionRequired
secretstringSecretfalse

Model Sync

Target

Webhook connections may be used as the destination in a model sync.

All targets

Configuration
NameTypeDescriptionRequired
batch_sizeintegerBatch size per requestfalse
metadataarrayMetadatafalse
record_requestsbooleanCapture webhook requests and responsesfalse
Example
{
  ...
  "target": {
      "configuration": {
        "batch_size": 0,
        "metadata": [
                {}
        ],
        "record_requests": false
    }
  }
}