Webhook | Polytomic Docs

Supports:

✅ Model sync destination

Connection

Configuration

Name	Type	Description	Required
`headers`	`array`	Headers	`false`
`url`	`string`	Webhook URL	`true`

Example

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

Read-only properties

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 }

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

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