Read a webhook

Read a webhook's configuration. The signing-secret setting is named, but its value is not returned.

GET /v1/tenants/{tenant}/webhooks/{hook_id}

Inspect how a webhook maps incoming dataThe signing-secret setting is named without exposing its value.

Select the registered hookUse the webhook ID.
Read its saved configurationInspect destination schema and field mappings.
Check signature settingsSee how deliveries are verified without reading the secret.

Before you start

Use your database bearer token.

Connection setup

Use the registered hook's ID. This request returns the secret setting's name, not the secret value.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`hook_id`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

Read the destination schema and field mappings to see how payloads become rows. The response names the signing-secret environment variable without exposing its value.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/webhooks/demo-people" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "hook_id": "demo-people",
  "config": {
    "schema": "demo.people",
    "field_mapping": {
      "id": "$.event.id",
      "follows_id": "$.event.follows_id",
      "score": "$.event.score"
    },
    "idempotency_key_path": "$.delivery_id",
    "signature": {
      "header": "X-Docs-Signature",
      "secret_env_var": "OC_DOCS_WEBHOOK_SECRET",
      "format": "hex_sha256"
    }
  }
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses