Skip to main content
POST
Give a table a webhook URL

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

Which kind of webhook feeds the table, from the webhook sources list.

integration_type
string
required

The app that sends it, as the webhook sources list names it.

Required string length: 1 - 255
mechanism_key
string
required

Which of the app's deliveries it is.

Required string length: 1 - 255
identity_path
string | null

Only for a source that takes one (takes_identity_path): the field in each record that tells rows apart, as a path such as person.email. Leave it out to add every record as a new row.

Required string length: 1 - 255
integration_id
string<uuid> | null

Only for a source that subscribes: the connection to the same app Oneprofile registers the URL through, from the integrations list. Leave it out for any other source.

Response

Successful Response

A new webhook URL, shown in full this once.

authentication
enum<string>
required

unsigned when the key in the URL is the only proof a delivery is the app's; signed when the app also signs each one. Fixed when the URL is made.

Available options:
signed,
unsigned
created_at
string<date-time>
required
delivered_last_24h
integer
required

Deliveries taken in the last 24 hours.

delivered_total
integer
required

Deliveries taken, ever.

failed_last_24h
integer
required

Deliveries that did not fit in the last 24 hours.

failed_total
integer
required

Deliveries that did not fit, ever.

id
string<uuid>
required
integration_type
string
required

The app that sends to it.

key_hint
string
required

The first characters of the URL's key, to tell URLs apart.

last_delivery_at
string<date-time> | null
required

When the last delivery came.

last_silence_notice_at
string<date-time> | null
required

When you were last told deliveries had stopped.

last_test_at
string<date-time> | null
required

When the app last sent a test delivery.

last_unsigned_surge_notice_at
string<date-time> | null
required

When you were last told of an unusual burst of new records.

mechanism_key
string
required

Which of the app's deliveries it takes.

old_key_expires_at
string<date-time> | null
required

Until when the key a new one replaced still works; null when it does not.

rejected_total
integer
required

Deliveries refused because they did not prove they came from the app, ever.

revoked_at
string<date-time> | null
required

When it was revoked; null while active.

status
enum<string>
required

active while it takes deliveries; revoked once it answers none.

Available options:
active,
revoked
table_id
string<uuid>
required
url
string | null
required

The URL to paste into the app, shown in full only here and by reveal. Null when the AI Assistant or an AI app made it: the URL is a password, so it is shown only on the table's Source panel.

subscription
WebhookSubscriptionReadSchema · object | null

Its registration with the app, when Oneprofile registers the URL through a connection; null when you paste the URL into the app yourself.