Webhook | Polytomic Docs

Supports:

✅ Model sync destination

Connection

Configuration

Name	Type	Description	Required
`auth_method`	`string`	Authentication method Accepted values: `polytomic_secret`, `basic` ↓, `header` ↓, `query` ↓, `oauth_client_credentials` ↓	`true`
`headers`	`array`	Additional headers	`false`
`url`	`string`	Webhook URL	`true`

`auth_method`

When `auth_method` is `basic`

Name	Type	Description	Required
`basic`	`object`	Basic authentication	`true`

When `auth_method` is `header`

Name	Type	Description	Required
`header`	`object`	Header	`true`

When `auth_method` is `oauth_client_credentials`

Name	Type	Description	Required
`oauth`	`object`	OAuth client credentials	`true`

When `auth_method` is `query`

Name	Type	Description	Required
`query`	`array`	Query string authentication parameters	`true`

Example

1 {
2   "name": "Webhook connection",
3   "type": "webhook",
4   "configuration": {
5     "auth_method": "",
6     "headers": [
7         {
8             "name": "foo",
9             "value": "bar"
10         }
11     ],
12     "url": "https://example.com/webhook"
13   }
14 }

Read-only properties

Name	Type	Description	Required

`auth_method`

When `auth_method` is `polytomic_secret`

Name	Type	Description	Required
`secret`	`string`	Secret	`false`

Model Sync

Target

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

All targets

Configuration

Name	Type	Description	Required
`batch_size`	`integer`	Batch size per request	`false`
`metadata`	`array`	Metadata	`false`
`record_requests`	`boolean`	Capture webhook requests and responses	`false`

Example

1 {
2   ...
3   "target": {
4       "configuration": {
5         "batch_size": 0,
6         "metadata": [
7                 {}
8         ],
9         "record_requests": false
10     }
11   }
12 }

Connection

Configuration

auth_method

When auth_method is basic

When auth_method is header

When auth_method is oauth_client_credentials

When auth_method is query

Example

Read-only properties

auth_method

When auth_method is polytomic_secret

Model Sync

Target

All targets

Configuration

Example

`auth_method`

When `auth_method` is `basic`

When `auth_method` is `header`

When `auth_method` is `oauth_client_credentials`

When `auth_method` is `query`

`auth_method`

When `auth_method` is `polytomic_secret`