POSTlive

Register or rotate the partner callback endpoint

Resolves and validates a public HTTPS destination before registration. Private, loopback, link-local, metadata, failed-DNS, and mixed-address targets are rejected; delivery revalidates and pins DNS. Canonical API flag required. Requires callbacks:manage and the platform orchestrator role; all results are tenant scoped.

/api/webhooks/endpointscreateOrRotateWebhookEndpoint

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

Parameters

Name	Location	Requirement	Schema
`Idempotency-Key`	header	Required	`{"type":"string","minLength":8,"maxLength":200}`

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/PartnerWebhookEndpointInput",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2000
    },
    "rotateFromEndpointId": {
      "type": "string"
    },
    "overlapSeconds": {
      "type": "integer",
      "minimum": 60,
      "maximum": 86400
    }
  },
  "dependentRequired": {
    "rotateFromEndpointId": [
      "overlapSeconds"
    ],
    "overlapSeconds": [
      "rotateFromEndpointId"
    ]
  }
}

Responses

201

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalCreateOrRotateWebhookEndpointResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalWebhookEndpointResult",
      "type": "object",
      "properties": {
        "endpoint": {
          "$ref": "#/components/schemas/CanonicalWebhookEndpoint",
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "partnerId": {
              "type": "string"
            },
            "url": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "active",
                "retiring",
                "disabled"
              ]
            },
            "signatureVersion": {
              "type": "string",
              "const": "pc-webhook-ed25519-v1"
            },
            "replacesEndpointId": {
              "type": "string"
            },
            "overlapUntil": {
              "type": "string"
            },
            "createdAt": {
              "type": "string"
            },
            "updatedAt": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "partnerId",
            "url",
            "status",
            "signatureVersion",
            "createdAt",
            "updatedAt"
          ]
        },
        "rotation": {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string"
            },
            "overlapUntil": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "endpoint"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ],
  "x-code-source": "lib/partner-api/v2/webhook-endpoints.ts"
}

default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "endpoint": {
      "id": "id_test",
      "partnerId": "partner_test_123",
      "url": "https://partner.test.example/callbacks/peoples-court",
      "status": "active",
      "signatureVersion": "pc-webhook-ed25519-v1",
      "createdAt": "createdAt_test",
      "updatedAt": "updatedAt_test"
    }
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

For throttling, honor Retry-After when present. Back off on retryable server failures.
Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.

Use https://peoplescourt.ai with the test credential issued for your integration.

cURL

curl --request POST \
  --url 'https://peoplescourt.ai/api/webhooks/endpoints' \
  --header 'Authorization: Bearer pk_test_replace_me' \
  --header 'Idempotency-Key: idem_test_12345678' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://partner.test.example/callbacks/peoples-court"
}'

TypeScript SDK

import type { PeopleCourtClient } from "./sdk/typescript/src/index.ts";

// Pass your configured client and this method’s typed arguments.
export async function request(client: PeopleCourtClient,
  ...args: Parameters<PeopleCourtClient["createOrRotateWebhookEndpoint"]>) {
  const response = await client.createOrRotateWebhookEndpoint(...args);
  return response.data;
}

Python

import requests

response = requests.post(
    "https://peoplescourt.ai/api/webhooks/endpoints",
    headers={
      "Authorization": "Bearer pk_test_replace_me",
      "Idempotency-Key": "idem_test_12345678",
      "Content-Type": "application/json"
    },
    json={"url": "https://partner.test.example/callbacks/peoples-court"},
    timeout=30,
)
response.raise_for_status()
result = response.json()