Create a Platform webhook endpoint

Creates a webhook endpoint for the API key's customer account. The signing secret is returned only in this response.

POST/api/platform/v1/webhook-endpoints

Creates a webhook endpoint for the API key's customer account. The signing secret is returned only in this response.

Authorization

platformApiKey

AuthorizationBearer <token>

CuraeAI Platform API key using the format Bearer . Keys are opaque credentials such as cae_live_..., not JWTs.

In: header

Header Parameters

Idempotency-Key?string

Optional idempotency key to make this mutation safe to retry. Replays of the same (apiKey, key) within 24h return the original response.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

eventTypes*array<|>

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/api/platform/v1/webhook-endpoints" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "eventTypes": [      "patient.created"    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "resourceType": "WebhookEndpoint",  "url": "http://example.com",  "eventTypes": [    "patient.created"  ],  "status": "ACTIVE",  "consecutiveFailures": 0,  "lastDeliveryAttemptAt": "2019-08-24T14:15:22Z",  "lastSuccessfulDeliveryAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "_version": "string",  "_links": {    "self": {      "href": "string"    }  },  "signingSecret": "string"}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "code": "string",  "details": {},  "retryable": true}