Connectors Reference

Pushcut

Pushcut is an app for iOS that lets you create smart notifications to kick off shortcuts, URLs, and online automations.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

GetDevices ()

Get devices

GetNotifications ()

Get notifications

SendNotification (string notificationName, Notification body)

Send a notification

DeleteSubscription (string subscriptionId)

Remove action webhook

 

Triggers:

Name

Summary

ActionExecuted (Subscription body)

When an action is executed

 

Objects:

Name

Summary

ActionExecutedResponse

 

DeleteSubscriptionResponse

 

GetDevicesResponseItem

 

GetNotificationsResponseItem

 

Notification

 

SendNotificationResponse

 

Subscription

 

 

Actions:

GetDevices

Summary: Get devices

Description: Gets a list of all active devices.

 

Syntax:

Pushcut.GetDevices ()

 

Returns:

          Type:array of (GetDevicesResponseItem)

 

GetNotifications

Summary: Get notifications

Description: Gets a list of all defined notifications.

 

Syntax:

Pushcut.GetNotifications ()

 

Returns:

          Type:array of (GetNotificationsResponseItem)

 

SendNotification

Summary: Send a notification

Description: Sends a smart notification to your devices

 

Syntax:

Pushcut.SendNotification (string notificationName, Notification body)

 

Parameters:

Name

Type

Summary

Required

Related Action

notificationName

string

(Notification)

Select a notification

True

GetNotifications

body

Notification

 

 

True

 

Returns:

          Type:SendNotificationResponse

 

DeleteSubscription

Summary: Remove action webhook

Description: Deletes a webhook subscription.

 

Syntax:

Pushcut.DeleteSubscription (string subscriptionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriptionId

string

 

 

True

 

Returns:

          Type:DeleteSubscriptionResponse

 

Triggers:

Trigger ActionExecuted

Summary: When an action is executed

Description: Triggers when an online action is executed.

 

Syntax:

Pushcut.ActionExecuted (Subscription body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Subscription

 

 

True

 

Returns:

          Type:ActionExecutedResponse

 


 

ActionExecutedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DeleteSubscriptionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetDevicesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Name of the device


 

GetNotificationsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Name of the notification definition

title

string

 

 


 

Notification

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

Dynamic Text

Text that is used instead of the one defined in the app.

title

string

Dynamic Title

Title that is used instead of the one defined in the app.

input

string

Input Parameter

Value that is passed as input to the notification action.

devices

array of (string)

Devices

List of devices this notification is sent to. (default is all devices)


 

SendNotificationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Subscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

actionName

string

Action Name

A unique name to identify the online action.

url

string

 

url