BlockCreatedEventData

This is an object representing data for the block created event.

object objectrequired

This is an object representing a range of blocked time for a provider, service, service provider, or location.

all_daybooleanrequired

Whether the block is all day.

attachment_typestringrequired

The type of attachment for the block.

Possible values: [location, service, provider, service_provider]

attachmentsstring[]required

The resources to which this block is attached. These can be service IDs (to block availabilty for all providers on a service), provider IDs (to block availability for a specific provider), or location IDs (to block availability for a specific location).

created_atstring<date-time>required

Time at which the object was created.

end_datestring<date>required

The end date of the block.

end_timestringnullablerequired

The end time of the block.

Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

exception_datesstring[]required

The exception dates for the block.

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^blk_\w{12}$

objectstringrequired

String representing the object's type.

Possible values: [block]

recurrence_rule objectnullable

The recurrence rule for the block (or null if there is no recurrence).

bydaystring[]

The days of the week on which the recurrence occurs.

Possible values: Value must match regular expression (mo|tu|we|th|fr|sa|su)$

Example: ["mo","we","fr"]

countintegernullable

Number of occurrences at which to end the recurrence.

Possible values: >= 1

freqstringrequired

The frequency of the recurrence.

Possible values: [daily, weekly]

intervalinteger

How often the recurrence rule repeats.

Possible values: >= 1

Example: 2

untildatenullable

Date at which to end the recurrence (in ISO-8601 format).

Example: 2024-01-02

service_idstringnullablerequired

The ID of the service for the block. Required when attachment_type is service_provider.

start_datestring<date>required

The start date of the block.

start_timestringnullablerequired

The start time of the block.

Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

time_zonestringnullablerequired

The time zone of the block.

titlestringnullablerequired

The title of the block.

updated_atstring<date-time>required

Time at which the object was last updated.

typestringrequired

The event type.

Possible values: [block.created]

BlockCreatedEventData

{
  "object": {
    "all_day": false,
    "attachment_type": "provider",
    "attachments": [
      "prov_d025a96ac0c6"
    ],
    "created_at": "2017-09-12T12:34:55Z",
    "end_date": "2025-10-27",
    "end_time": "17:00",
    "exception_dates": [
      "2025-10-27T09:00:00"
    ],
    "id": "blk_d025a96ac0c6",
    "object": "block",
    "recurrence_rule": {
      "byday": [
        "mo",
        "we",
        "fr"
      ],
      "freq": "weekly"
    },
    "service_id": null,
    "start_date": "2025-10-27",
    "start_time": "09:00",
    "time_zone": "America/New_York",
    "title": "Team Meeting",
    "updated_at": "2017-09-13T10:11:12Z"
  },
  "type": "block.created"
}