WebhookPayload

Description

A WebhookPayload is virtual resource that represents a webhook payload sent to a pre configured webhook URL. A WebhookPayload can contain any resource or fields you have subscribed to. See Setting up webhooks for more information.

Endpoints

  • There are no endpoints as this is a virtual resource only being sent to a webhook URL.

Attributes

Field
Type
Description

webhookId

UUID

The webhook id of the triggered webhook

event

String

The event that triggered the webhook e.g create or update

fields

String array

Fields that triggered the webhook in case of being subscribed to (update of) specific fields.

resource

Object

The full resource.

Reference documentation

Webhooks

Setting up webhooks

Last updated