<- Object

Object

All versions ->

WebhookSubscription

Represents the details of a webhook subscription, including notification URL, event types, and signature key.

Link to section

Properties

Link to section

id

string

Read only A Square-generated unique ID for the subscription.

Max Length
64
Link to section

name

string

The name of this subscription.

Max Length
64
Link to section

enabled

boolean

Indicates whether the subscription is enabled (true) or not (false).

Link to section

event_types

string [ ]

The event types associated with this subscription.

Link to section

notification_url

string

The URL to which webhooks are sent.

Link to section

api_version

string

The API version of the subscription. This field is optional for CreateWebhookSubscription. The value defaults to the API version used by the application.

Link to section

signature_key

string

Read only The Square-generated signature key used to validate the origin of the webhook event.

Link to section

created_at

string

Read only The timestamp of when the subscription was created, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

updated_at

string

Read only The timestamp of when the subscription was last updated, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z".

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00