> ## Documentation Index > Fetch the complete documentation index at: https://docs.stackone.com/llms.txt > Use this file to discover all available pages before exploring further. # Pushwoosh > How to set up the Pushwoosh connector, plus the actions and events that are available. ![Pushwoosh](https://stackone-logos.com/api/pushwoosh/filled/svg) Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/pushwoosh/changelog.md) [150 actions](#actions) · [16 events](#events) · 3 auth methods Marketing ## Getting Started **1. Create or Select a Project** Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md). **2. Configure the Connector** Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile). > [card] [Connector Profile · API Token (Server and Device)](https://docs.stackone.com/connectors/pushwoosh/guides/connector-profile/api-token-server-and-device.md) > > Recommended. Uses both a Pushwoosh Server API token and a Device API token, so one account can run every action, includi... > [card] [Connector Profile · API Token (Server)](https://docs.stackone.com/connectors/pushwoosh/guides/connector-profile/api-token-server.md) > > Uses a Pushwoosh Server API token. Covers every management, messaging and statistics action, but cannot register users,... > [card] [Connector Profile · API Token (Device)](https://docs.stackone.com/connectors/pushwoosh/guides/connector-profile/api-token-device.md) > > For setups that only send device, user, tag and event data into Pushwoosh. Uses a Device API token, which cannot call ma... Optionally, configure receiving Events for Pushwoosh into StackOne. > [card] [Webhooks setup](https://docs.stackone.com/connectors/pushwoosh/guides/webhook-setup.md) **3. Link an Account** Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)). See the guide for the authentication type chosen in the Connector Profile: > [card] [Link Account · API Token (Server and Device)](https://docs.stackone.com/connectors/pushwoosh/guides/link-account/api-token-server-and-device.md) > [card] [Link Account · API Token (Server)](https://docs.stackone.com/connectors/pushwoosh/guides/link-account/api-token-server.md) > [card] [Link Account · API Token (Device)](https://docs.stackone.com/connectors/pushwoosh/guides/link-account/api-token-device.md) **4. Use Actions** Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md). Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md). ## Actions Authentication type Select all | Clear API Token (Device) API Token (Server and Device) API Token (Server) No auth methods found 150 actions ActionDescription Validate Apple Pass`pushwoosh_validate_apple_pass` Checks a pass configuration against Apple's specifications without creating a file. Useful before calling create. Create Apple Pass`pushwoosh_create_apple_pass` Generates, signs, and stores a new pass, then returns its server-assigned serial number. Update Apple Pass`pushwoosh_update_apple_pass` Regenerates the pass with new content, re-signs it, increments its update tag, and sends a silent push notification to e... List Apple Passes`pushwoosh_list_apple_passes` Returns a paginated, sorted list of the passes stored for an application. Get Apple Pass`pushwoosh_get_apple_pass` Returns a single stored pass, including its full pass object. Download Apple Pass`pushwoosh_download_apple_pass` Returns the stored .pkpass file of an existing pass. Delete Apple Pass`pushwoosh_delete_apple_pass` Removes a pass record and its stored .pkpass file. List Apple Pass Registrations`pushwoosh_list_apple_pass_registrations` Lists the devices that have added the pass and are registered for updates. Get Apple Wallet Configuration`pushwoosh_get_apple_wallet_config` Returns the PassKit configuration resolved for an application from its certificate. List Apple Pass Templates`pushwoosh_list_apple_pass_templates` List the available pass templates, or fetch one as a pass object you can use as a starting point. Get Apple Pass Template`pushwoosh_get_apple_pass_template` Fetch a template as a pass object you can use as a starting point. Create Application`pushwoosh_create_application` Creates a new application on the account. Update Application`pushwoosh_update_application` Updates the application settings. Delete Application`pushwoosh_delete_application` Deletes the app from the account. Get Application`pushwoosh_get_application` Gets details about the app. List Applications`pushwoosh_list_applications` Gets the list of applications on the account. Can return result with pagination. Get Application File`pushwoosh_get_application_file` Gets the configuration files related to the app. Set Application Platform Status`pushwoosh_set_application_platform_status` Changes the platform's status of the app. Configure Application Platform`pushwoosh_configure_application` Configures the platform for the app. All platforms use the same /configureApplication method; parameters differ per plat... Bulk Set Tags`pushwoosh_bulk_set_tags` Sets tag values for the list of devices. Get Bulk Set Tags Status`pushwoosh_get_bulk_set_tags_status` Returns the status of `/bulkSetTags` operation Bulk Register Devices`pushwoosh_bulk_register_devices` Registers multiple devices in Pushwoosh in a single request. It also allows specifying various tags for each device. Get Bulk Register Devices Status`pushwoosh_get_bulk_register_devices_status` You can check the status of a bulk registration process by making the following GET request. Bulk Unregister Devices`pushwoosh_bulk_unregister_devices` Unregisters multiple devices from Pushwoosh in a single request. Get Bulk Unregister Devices Status`pushwoosh_get_bulk_unregister_devices_status` You can check the status of a bulk un-registration process by making the following GET request. Create Campaign`pushwoosh_create_campaign` Creates a push campaign within the app. Delete Campaign`pushwoosh_delete_campaign` Deletes a particular campaign. List Campaigns`pushwoosh_list_campaigns` Retrieves the list of campaigns for the app. List Control Groups`pushwoosh_list_control_groups` Lists every control group configured for an application, the unnamed original one first. Create Control Group`pushwoosh_create_control_group` Creates a named control group for an application and returns it with its generated code. The new group holds users out o... Get Control Group`pushwoosh_get_control_group` Returns one control group by its code, with its hold-out size, generation, and the user counts behind it. Update Control Group Percentage`pushwoosh_update_control_group_percentage` Sets the hold-out percentage (1–20) of one control group. Resizing keeps every existing member: the hold-out grows or sh... Update Control Group Countries`pushwoosh_update_control_group_countries` Sets the countries one control group is scoped to. Changing the scope restarts the uplift measurement, because the popul... Update Control Group Settings`pushwoosh_update_control_group_settings` Applies a control group's size, country and tag scope, and lifetime mode in one call. A change that alters who is held o... Rename Control Group`pushwoosh_rename_control_group` Sets the name the Control Panel shows for one control group. `name` is part of the membership key and doesn't change, so... Disable Control Group`pushwoosh_disable_control_group` Switches one control group off, keeping it and its generation so that switching it back on restores the same hold-out ra... Reshuffle Control Group`pushwoosh_reshuffle_control_group` Redraws one control group's hold-out by incrementing its generation. This is the only way to get a different sample: mem... Force Recalculate Control Group`pushwoosh_recalculate_control_group` Starts a fresh count of one control group's size. The previously cached numbers keep being served until the new count fi... Get Control Group Calculation Status`pushwoosh_get_control_group_calculation_status` Polls just the changing user counts of one control group while a size calculation runs. Get Control Group Analytics`pushwoosh_get_control_group_analytics` Returns the precomputed Control-vs-Treatment analytics for one control group. List Control Group Cycles`pushwoosh_list_control_group_cycles` Lists the closed cycles of one control group, newest first. Each cycle is the membership the group ran with between two... Check Control Group Membership`pushwoosh_check_control_group_membership` Reports for each user ID whether it is held out by one control group right now. Membership is computed from the ID alone... Delete Control Group`pushwoosh_delete_control_group` Removes a control group entirely. It stops holding users out, and its statistics can no longer be opened. The applicatio... Create Data Erasure Task`pushwoosh_create_data_erasure_task` Starts erasing the personal data of the listed subjects in the listed applications. With `dry_run: true` the task only c... Get Data Erasure Journal Report`pushwoosh_get_data_erasure_journal_report` Returns every erasure of a period as one CSV file: a row per identifier per application, with the task and its initiator... Get Data Erasure Task`pushwoosh_get_data_erasure_task` Returns one erasure task with its status and counters. Use it to follow a task started by Create or Upload. Get Data Erasure Task Report`pushwoosh_get_data_erasure_task_report` Returns the whole report of one task as a CSV file: one row per identifier per application, with its outcome. ListTaskRo... List Data Erasure Task Rows`pushwoosh_list_data_erasure_task_rows` Returns the per-identifier outcome of one task: what was deleted, not found, skipped, or failed. Identifiers are reporte... List Data Erasure Tasks`pushwoosh_list_data_erasure_tasks` Lists the erasures of the account, newest first: the audit journal of who erased what and when. Dry runs are left out un... Upload Data Erasure CSV`pushwoosh_upload_data_erasure_task` Creates the same kind of task as Create, but the identifiers come from an uploaded CSV instead of a JSON array. Use this... Delete Device`pushwoosh_delete_device` Deletes a device and all its associated data identified by the specified HWID within the application. Unlike /unregister... Get Device Tags`pushwoosh_get_tags` Retrieves a list of tags with corresponding values for the specific device. Register Device`pushwoosh_register_device` Called internally from the SDK. Registers device for the application. Set Badge`pushwoosh_set_badge` This endpoint is disabled. The server no longer stores or acts on the badge value it receives. Badge state is managed en... Set Device Tags`pushwoosh_set_tags` Sets tags values for the device. Called from the SDK. Track Application Open`pushwoosh_track_application_open` Registers an app open event. Called internally from the SDK. Track Message Delivery`pushwoosh_track_message_delivery` Registers push delivery event for the device. Called internally from the SDK. Track Push Open`pushwoosh_track_push_stat` Registers a push open event. Called internally from the SDK. Unregister Device`pushwoosh_unregister_device` Removes the device's push token. The unregistered device is still counted in Total Devices and can be reached with In-Ap... Register Email`pushwoosh_register_email` Registers email address for the app. Delete Email`pushwoosh_delete_email` Removes email address from your user base. Set Email Tags`pushwoosh_set_email_tags` Sets tag values for the email address. Register Email User`pushwoosh_register_email_user` Associates an external User ID with a specified email address. Create Email Template`pushwoosh_create_email_template` Creates a new email template - its editor content plus a connected email preset - in an application, and returns the gen... List Email Templates`pushwoosh_list_email_templates` Lists an application's email templates - metadata only, no content - with paging, ordering, and filtering by name, label... Get Email Template`pushwoosh_get_email_template` Returns a single email template by its code, including sender info, per-locale subjects, and the full editor content. Update Email Template`pushwoosh_update_email_template` Updates an existing email template by code, overwriting the supplied fields. Delete Email Template`pushwoosh_delete_email_template` Deletes an email template and its connected preset by code, removing the stored content. Clone Email Template`pushwoosh_clone_email_template` Clones an email template - its content and preset - into a destination application, optionally under a new name. Create Event`pushwoosh_create_event` Creates an Event for the app. Get Nearest Geozone`pushwoosh_get_nearest_geozone` Called internally from the SDK. Retrieves the parameters of the nearest geozone and the distance to it. Also records the... Create Geozone`pushwoosh_create_geozone` Adds a Geozone to a specific app. Update Geozone`pushwoosh_update_geozone` Updates Geozone properties. Delete Geozone`pushwoosh_delete_geozone` Removes Geozones from the app. Create Geozone Cluster`pushwoosh_create_geozone_cluster` Adds Geozone Cluster to the app. Delete Geozone Cluster`pushwoosh_delete_geozone_cluster` Removes a Geozone Cluster from the app. List Geozones`pushwoosh_list_geozones` Retrieves a list of Geozones for the app. List Geozone Clusters`pushwoosh_list_geozone_clusters` Retrieves a list of Geozone clusters for the app. Validate Google Pass`pushwoosh_validate_google_pass` Checks a pass configuration against Google's requirements without creating it. Useful before calling create. Create Google Pass`pushwoosh_create_google_pass` Creates the pass class and object in Google Wallet, then returns the server-assigned serial number, the full object id,... Update Google Pass`pushwoosh_update_google_pass` Patches the pass object with new content. Google then delivers the updated version to every device that saved the pass.... Get Google Pass Save Link`pushwoosh_get_google_pass_save_link` Returns an "Add to Google Wallet" save link for an already created pass. The pass object must already exist (created via... Get Google Pass`pushwoosh_get_google_pass` Returns a single stored pass, including its full pass object. List Google Passes`pushwoosh_list_google_passes` Returns a paginated, sorted list of the passes stored for an application. Set Google Pass State`pushwoosh_set_google_pass_state` Activates or invalidates a pass. An invalidated (inactive) pass moves to the user's Expired passes section in Google Wal... Delete Google Pass`pushwoosh_delete_google_pass` Invalidates the pass in Google and removes its stored record in Pushwoosh. Get Google Wallet Configuration`pushwoosh_get_google_wallet_config` Returns the Google Wallet configuration state for an application. List Google Pass Templates`pushwoosh_list_google_pass_templates` List the available example pass templates, or fetch one as a pass object you can use as a starting point. Get Google Pass Template`pushwoosh_get_google_pass_template` List the available example pass templates, or fetch one as a pass object you can use as a starting point. Get Inbox Messages`pushwoosh_list_inbox_messages` Returns the list of Inbox messages for a specified HWID. Update Inbox Message Status`pushwoosh_update_inbox_status` Updates the status of a particular Inbox message. Create Journey`pushwoosh_create_journey` Creates a new journey in the STATUS\_DRAFT state. Update Journey`pushwoosh_update_journey` Replaces the definition of an existing journey. Send the complete definition. The points and comments you submit replace... Rename Journey`pushwoosh_rename_journey` Changes only the journey title, without touching its points or settings. Start Journey`pushwoosh_start_journey` Moves a journey to STATUS\_RUNNING. Pass the Journey ID as uuid in the request body. Returns the updated journey object. Pause Journey`pushwoosh_pause_journey` Moves a journey to STATUS\_PAUSED. Pass the Journey ID as uuid in the request body. Returns the updated journey object. Finish Journey`pushwoosh_finish_journey` Moves a journey to STATUS\_FINISHED. Pass the Journey ID as uuid in the request body. Returns the updated journey object. Archive Journey`pushwoosh_archive_journey` Moves a journey to STATUS\_ARCHIVED. Pass the Journey ID as uuid in the request body. Archived is terminal and cannot be... Start Journey For Users (API Entry)`pushwoosh_trigger_journey` Enters a set of users into a journey's API entry point. Use it to drive journeys from your own backend. Get Journey Stats`pushwoosh_get_journey_stats` Returns statistics for a Customer Journey by its ID. Remove Users From Journeys`pushwoosh_remove_users_from_journeys` Removes a list of users from all or specific active journeys. Start Live Activity`pushwoosh_start_live_activity` Allows creating iOS Live Activities. Update Live Activity`pushwoosh_update_live_activity` Allows updating and ending iOS Live Activities Notify (Send Message)`pushwoosh_send_message` Creates and schedules a single message. Cancel Message (v2)`pushwoosh_cancel_message_v2` Cancels a previously created message, identified by its message\_code. Cancellation is available only while the message i... Update Scheduled Message (v2)`pushwoosh_update_message` Replaces a previously created message, identified by its message\_code, with a new definition. The replacement is a full... Delete Message`pushwoosh_delete_message` Deletes a message, whether it's still scheduled or has already been sent. For a scheduled message, this also removes it... Get Message Details`pushwoosh_get_message_details` Retrieves the message details. Create Preset`pushwoosh_create_preset` Creates a new push preset in an application and returns it with its generated code. List Presets`pushwoosh_list_presets` Lists an application's push presets - a reduced field set, not the full object - with paging, ordering, and filtering by... Get Preset`pushwoosh_get_preset` Returns a single push preset by its code, with every field of the Preset object populated. Update Preset`pushwoosh_update_preset` Overwrites an existing push preset by code with the supplied fields. Update Preset Partially`pushwoosh_patch_preset` Updates only the supplied fields of an existing push preset by code, leaving unset fields unchanged. Clone Preset`pushwoosh_clone_preset` Duplicates an existing push preset, under a new name, into the same application. Delete Preset`pushwoosh_delete_preset` Permanently deletes a push preset by code. Get Scheduled Request Results`pushwoosh_get_scheduled_request_results` Retrieves the result of a scheduled request. Create Segment (Filter)`pushwoosh_create_segment` Creates a new filter. List Segments (Filters)`pushwoosh_list_segments` Returns a list of available segments (filters) with their conditions. Delete Segment (Filter)`pushwoosh_delete_segment` Deletes an existing filter. Export Segment`pushwoosh_export_segment` A scheduled request. Exports the list of subscribers that fall under specified Filter conditions. Get Segment Export Result`pushwoosh_get_segment_export_result` Retrieves the link to the CSV with the /exportSegment results. List Sent Messages`pushwoosh_list_sent_messages` Displays the list of sent messages. Get Message Totals By Intervals`pushwoosh_get_message_totals_by_intervals` Returns metrics and conversion data based on the message code, aggregated by hour. Get Delivery Funnel`pushwoosh_get_delivery_funnel` Returns one message's funnel. Get Campaign Delivery Funnel`pushwoosh_get_campaign_delivery_funnel` Sums getDeliveryFunnel over a campaign's messages. Unique counts are calculated per message: a subscriber reached by sev... Get Message Log`pushwoosh_get_message_log` Displays detailed information about the messages sent. Get Email Links Interactions`pushwoosh_get_email_links_interactions` Displays statistics on link clicks in emails List Email Link Clickers`pushwoosh_list_email_links_interactions_devices` Shows users who clicked on links in emails List Bounced Emails`pushwoosh_list_bounced_emails` Provides data on email complaints, soft bounces, and hard bounces, including the date, email address, and reason for eac... Get Application Subscribers Stats`pushwoosh_get_application_subscribers_stats` Displays the app's subscribers list grouped by the types of their devices. Get App Stats`pushwoosh_get_app_stats` Get the statistics of a specific app for a defined time period. Get Subscribers Statistics`pushwoosh_get_subscribers_statistics` Retrieves app subscribers stats for a time period. Get Campaign Stats`pushwoosh_get_campaign_stats` Retrieve statistics of a particular campaign for a specific time period. Get Event Statistics`pushwoosh_get_event_statistics` Retrieves the number of times an event was triggered during a specified period. Get Tag Stats`pushwoosh_get_tag_stats` Retrieves statistics for a specific tag. Get In-App Totals`pushwoosh_get_inapp_totals` Returns totals for the period. Pass inapp\_codes to report on specific campaigns, or omit it to walk every in-app of the... Export Messages Statistics`pushwoosh_export_messages_statistics` Queues a message history export and returns a task identifier right away. Get Messages Statistics Export Status`pushwoosh_get_messages_statistics_export_status` Returns the progress of an export task. Get Messages Statistics Export Result`pushwoosh_get_messages_statistics_export_result` Returns the generated file name once the task has completed. List Messages Statistics Exports`pushwoosh_list_messages_statistics_exports` Lists recent export tasks for an application, most recent first. Delete Messages Statistics Export`pushwoosh_delete_messages_statistics_export` Deletes a task and its file before the 7-day retention window expires. Download Messages Statistics Export`pushwoosh_download_messages_statistics_export` Downloads the CSV file generated by `result`, by name. Create Tag`pushwoosh_create_tag` Creates a tag in your account. Delete Tag`pushwoosh_delete_tag` Completely removes a tag with all the associated information from the database. List Tags`pushwoosh_list_tags` Retrieves a list of tags on the account. Create Test Device`pushwoosh_create_test_device` Registers a test device for the application. List Test Devices`pushwoosh_list_test_devices` Returns all the test devices for the specific application. Register User`pushwoosh_register_user` Associates external User ID with a specified device. Delete User`pushwoosh_delete_user` Deletes a user and all devices associated with the specified User ID within the application. The request is processed as... Post Event`pushwoosh_post_event` Triggers an event. ## Events Tags Select all | Clear Devices Emails Events Messages Webhooks No tags found 16 events EventDescriptionTags Push Sent`pushwoosh_webhook_push_sent` Fired when Pushwoosh sends a push notification to a device. MessagesWebhooks Push Delivered`pushwoosh_webhook_push_delivered` Fired when a push notification is delivered to a device. MessagesWebhooks Push Opened`pushwoosh_webhook_push_opened` Fired when a user opens a push notification. MessagesWebhooks Email Sent`pushwoosh_webhook_email_sent` Fired when Pushwoosh sends an email. EmailsWebhooks Email Delivered`pushwoosh_webhook_email_delivered` Fired when an email is delivered to the recipient's mail server. EmailsWebhooks Email Opened`pushwoosh_webhook_email_opened` Fired when a recipient opens an email. EmailsWebhooks Email Bounced`pushwoosh_webhook_email_bounced` Fired when an email bounces with a permanent error. EmailsWebhooks Email Unsubscribed`pushwoosh_webhook_email_unsubscribed` Fired when a recipient unsubscribes through an email. EmailsWebhooks SMS Sent`pushwoosh_webhook_sms_sent` Fired when Pushwoosh sends an SMS. MessagesWebhooks SMS Delivered`pushwoosh_webhook_sms_delivered` Fired when an SMS is delivered to the recipient. MessagesWebhooks SMS Not Delivered`pushwoosh_webhook_sms_not_delivered` Fired when an SMS fails to deliver. MessagesWebhooks In-App Shown`pushwoosh_webhook_inapp_shown` Fired when an in-app message is shown to a user (PW\_InAppShow post event). EventsWebhooks In-App Clicked`pushwoosh_webhook_inapp_clicked` Fired when a user clicks an in-app message (PW\_InAppClicked post event). EventsWebhooks Device Registered`pushwoosh_webhook_device_registered` Fired when a device registers for push notifications (PW\_DeviceRegistered post event). DevicesWebhooks Device Unregistered`pushwoosh_webhook_device_unregistered` Fired when a device unregisters from push notifications (PW\_DeviceUnregistered post event). DevicesWebhooks Custom Event`pushwoosh_webhook_custom_event` Fired for any other post event, such as a custom event recorded with postEvent, when it is selected under Post events. EventsWebhooks This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.