Retrieve an inbound webhook schema

Returns the schema Jelliu inferred from the first payload a webhook integration received: the likely entity type, each field with its detected type, a sample value and a confidence score, and a suggested mapping onto Jelliu contact fields. Use suggestedMapping as the starting point for fieldMapping in PATCH /api/integrations/{integrationId}.

data is null until the first push arrives, and always null for non-webhook integrations. The schema is captured once and not re-inferred on later pushes.

Consistency. Cached for up to 5 minutes and cleared on every write to the integration.

Access

Required scope: read (or write). Any workspace member can call it.
Rate limit: General API — 120 to 600 requests/min per workspace depending on plan. See Rate limits.
Plan: Available on every plan.

Returns the schema Jelliu inferred from the first payload a `webhook` integration received: the likely entity type, each field with its detected type, a sample value and a confidence score, and a suggested mapping onto Jelliu contact fields. Use `suggestedMapping` as the starting point for `fieldMapping` in `PATCH /api/integrations/{integrationId}`. `data` is `null` until the first push arrives, and always `null` for non-webhook integrations. The schema is captured once and not re-inferred on later pushes. **Consistency.** Cached for up to 5 minutes and cleared on every write to the integration. **Access** - **Required scope:** `read` (or `write`). Any workspace member can call it. - **Rate limit:** General API — 120 to 600 requests/min per workspace depending on plan. See [Rate limits](/rate-limits). - **Plan:** Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

Scope	GET / HEAD	POST / PUT / PATCH / DELETE	Admin-only routes
`read`	Yes	No	No
`write`	Yes	Yes	No
`full`	Yes	Yes	Yes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Workspace API key: `jl_` followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (**Settings → API Keys**) and sent as `Authorization: Bearer jl_...`. The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys. | Scope | GET / HEAD | POST / PUT / PATCH / DELETE | Admin-only routes | | --- | --- | --- | --- | | `read` | Yes | No | No | | `write` | Yes | Yes | No | | `full` | Yes | Yes | Yes | Operations restricted to admins or owners reject keys without the `full` scope with `403`, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See [Authentication](/authentication).

Path parameters

integrationIdstringRequiredformat: "uuid"

A webhook integration id. A value that is not a UUID is rejected with 400.

Response

The discovered schema, or null.

dataobject or null

null when nothing has been received yet or the integration is not a webhook.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

data is null until the first push arrives, and always null for non-webhook integrations. The schema is captured once and not re-inferred on later pushes.

Consistency. Cached for up to 5 minutes and cleared on every write to the integration.

Access

Required scope: read (or write). Any workspace member can call it.
Rate limit: General API — 120 to 600 requests/min per workspace depending on plan. See Rate limits.
Plan: Available on every plan.