For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Webhooks
      • POSTCreate Webhook
      • GETGet Webhook
      • PUTUpdate Webhook
      • DELDelete Webhook
      • POSTDisable Webhook
      • POSTEnable Webhook
Logo
Log inBook a demo
API ReferenceWebhooks

Create Webhook

POST
https://app.polytomic.com/api/webhooks
POST
/api/webhooks
$curl -X POST https://app.polytomic.com/api/webhooks \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "endpoint": "https://example.com/webhook",
>  "secret": "string"
>}'
1{
2  "data": {
3    "created_at": "2024-01-01T00:00:00Z",
4    "disabled": true,
5    "endpoint": "https://example.com/webhook",
6    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
8    "secret": "secret"
9  }
10}

Creates the organization’s webhook.

📘 One webhook per organization

An organization can register a single webhook, which receives every event produced in that organization. See the Events documentation for the list of event types and payload shapes.

Was this page helpful?
Previous

Get Webhook

Next

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
endpointstringRequired
secretstringRequired6-32 characters
organization_idstring or nullOptionalformat: "uuid"

Response

OK
dataobject

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error