API ReferenceWebhook Endpoints

Put webhook endpoint configurationv3.1

POST
/api/v3.1/webhook_endpoints/{nano_id}

Full replacement of webhook endpoint configuration. All required setup fields must be provided. Use PATCH to update individual fields.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Path Parameters

nano_idstringRequired

Webhook endpoint nano ID (e.g., we_abc123)

Request Body

application/json

dataobjectRequired

Key-value pairs for ALL required setup_fields. Unlike PATCH, all required fields must be provided — this is initial configuration.

Response Body

application/json

application/json

application/json

application/json

application/json

import requestsurl = "https://example.com/api/v3.1/webhook_endpoints/string"body = """{  "data": {    "property1": "string",    "property2": "string"  }}"""response = requests.request("POST", url, data = body, headers = {  "Content-Type": "application/json"})print(response.text)
{  "id": "string",  "toolkit_slug": "string",  "client_id": "string",  "webhook_url": "string",  "data": {    "property1": "string",    "property2": "string"  },  "created_at": "string"}
Edit this page on GitHub