Skip to main content
WEBHOOK

Body

application/json

The envelope every v2 webhook notification arrives in. The product-specific fields live in notification.

​
subscriptionId
string<uuid>
required

ID of the webhook subscription that produced this notification.

​
notificationId
string<uuid>
required

Unique ID for this event. Stable across retries of the same delivery, so use it to deduplicate.

​
notificationType
enum<string>
required

The type of notification.

Available options:
onboarding.applicationRfiRequested
​
notification
any
required

The event payload. The schema of this object depends on notificationType.

​
timestamp
string<date-time>
required

When the notification was produced.

​
version
integer
required

The version of the notification schema. Always 2.

Response

200

Webhook received successfully