Represents the details of a webhook subscription, including notification URL, event types, and signature key.
WebhookSubscription
| Name | Type | Tags | Description | Getter |
|---|---|---|---|---|
Id |
String |
Optional | A Square-generated unique ID for the subscription. Constraints: Maximum Length: 64 |
String getId() |
Name |
String |
Optional | The name of this subscription. Constraints: Maximum Length: 64 |
String getName() |
Enabled |
Boolean |
Optional | Indicates whether the subscription is enabled (true) or not (false). |
Boolean getEnabled() |
EventTypes |
List<String> |
Optional | The event types associated with this subscription. | List getEventTypes() |
NotificationUrl |
String |
Optional | The URL to which webhooks are sent. | String getNotificationUrl() |
ApiVersion |
String |
Optional | The API version of the subscription. This field is optional for CreateWebhookSubscription.The value defaults to the API version used by the application. |
String getApiVersion() |
SignatureKey |
String |
Optional | The Square-generated signature key used to validate the origin of the webhook event. | String getSignatureKey() |
CreatedAt |
String |
Optional | The timestamp of when the subscription was created, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". | String getCreatedAt() |
UpdatedAt |
String |
Optional | The timestamp of when the subscription was last updated, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". |
String getUpdatedAt() |
{
"id": "id8",
"name": "name8",
"enabled": false,
"event_types": [
"event_types6"
],
"notification_url": "notification_url2"
}