FileMaster

Edit File: webhook-subscription.md

# Webhook Subscription

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

## Structure

`WebhookSubscription`

## Fields

| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `id` | `?string` | Optional | A Square-generated unique ID for the subscription. **Constraints**: *Maximum Length*: `64` | getId(): ?string | setId(?string id): void |
| `name` | `?string` | Optional | The name of this subscription. **Constraints**: *Maximum Length*: `64` | getName(): ?string | setName(?string name): void |
| `enabled` | `?bool` | Optional | Indicates whether the subscription is enabled (`true`) or not (`false`). | getEnabled(): ?bool | setEnabled(?bool enabled): void |
| `eventTypes` | `?(string[])` | Optional | The event types associated with this subscription. | getEventTypes(): ?array | setEventTypes(?array eventTypes): void |
| `notificationUrl` | `?string` | Optional | The URL to which webhooks are sent. | getNotificationUrl(): ?string | setNotificationUrl(?string notificationUrl): void |
| `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. | getApiVersion(): ?string | setApiVersion(?string apiVersion): void |
| `signatureKey` | `?string` | Optional | The Square-generated signature key used to validate the origin of the webhook event. | getSignatureKey(): ?string | setSignatureKey(?string signatureKey): void |
| `createdAt` | `?string` | Optional | The timestamp of when the subscription was created, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
| `updatedAt` | `?string` | Optional | The timestamp of when the subscription was last updated, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |

## Example (as JSON)

```json
{
  "id": "id8",
  "name": "name8",
  "enabled": false,
  "event_types": [
    "event_types6"
  ],
  "notification_url": "notification_url2"
}
```

Back