HighLevel: Create notification

← Calendars operations · Get started

Operation gohighlevel.create_event_notification

Provider route: POST /calendars/{calendarId}/notifications. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["calendars"]["createEventNotification"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.calendars.createEventNotification(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.calendars.create_event_notification(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.calendarId	string	Required within parent
body	array	Required within parent
body[]	Model	Each item	Expand Create notification — request body — body item

Referenced models: Create notification — request body — body item

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	array	Root
$[]	Model	Each item	Expand Get notification — response body

Referenced models: Get notification — response body

Schemas

Create notification — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
additionalEmailIds	array	Optional	Additional email addresses to receive notifications.
additionalEmailIds[]	string	Each item
additionalPhoneNumbers	array	Optional	Additional phone numbers to receive notifications.
additionalPhoneNumbers[]	string	Each item
afterTime	array	Optional	Specifies the time after which the follow-up notification should be sent. This is not required for other notification types.
afterTime[]	Model	Each item	Expand Update notification — request body — body after Time item
beforeTime	array	Optional	Specifies the time before which the reminder notification should be sent. This is not required for other notification types.
beforeTime[]	Model	Each item	Expand Update notification — request body — body after Time item
body	string	Optional	Body for email notification. Not necessary for in-App notification
channel	string	Required within parent	Notification channel One of: email, inApp, sms, whatsapp
fromAddress	string	Optional	from address for email notification
fromName	string	Optional	from name for email/sms notification
fromNumber	string	Optional	from number for sms notification
isActive	boolean	Optional	Is the notification active Default: true
notificationType	string	Required within parent	Notification type One of: booked, confirmation, cancellation, reminder, followup, reschedule
receiverType	string	Required within parent	notification recipient type One of: contact, guest, assignedUser, emails, phoneNumbers, business
selectedUsers	array	Optional	Selected users for in-App and business email notifications. Supports user IDs and special keyword "sub_account_admin"
selectedUsers[]	string	Each item
subject	string	Optional	Subject for email notification. Not necessary for in-App notification
templateId	string	Optional	Template ID for email notification. Not necessary for in-App notification

Referenced models: Update notification — request body — body after Time item

Get notification — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Optional	Notification ID
additionalEmailIds	array	Optional
additionalEmailIds[]	string	Each item
additionalPhoneNumbers	array	Optional
additionalPhoneNumbers[]	string	Each item
additionalWhatsappNumbers	array	Optional
additionalWhatsappNumbers[]	string	Each item
afterTime	array	Optional
afterTime[]	Model	Each item	Expand Get notification — response body — after Time item
beforeTime	array	Optional
beforeTime[]	Model	Each item	Expand Get notification — response body — after Time item
body	string	Optional
channel	string	Optional	Known values: email, inApp, sms, whatsapp
deleted	boolean	Optional
isActive	boolean	Optional
notificationType	string	Optional	Known values: booked, confirmation, cancellation, reminder, followup, reschedule
receiverType	string	Optional	Known values: contact, guest, assignedUser, emails, phoneNumbers, business
selectedUsers	array	Optional
selectedUsers[]	string	Each item
subject	string	Optional
templateId	string	Optional

Referenced models: Get notification — response body — after Time item

Update notification — request body — body after Time item

Field	Type	Presence	Description and constraints
$	object	Root
timeOffset	number	Optional
unit	string	Optional

Get notification — response body — after Time item

Field	Type	Presence	Description and constraints
$	object	Root
timeOffset	JSON	Optional
timeOffset (anyOf 1)	number	Alternative
timeOffset (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit	string	Optional

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_event_notification. Catalog operation: create-event-notification. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["calendars/events.write"]

Pinned headers: {"Version": "v3"}

Official provider source