Workflows API — trigger and manage partner automations

PartnerOS workflows automate repetitive partner lifecycle tasks — sending welcome emails when a partner joins, triggering enablement training after an agreement is signed, or notifying your team when a deal closes. The workflow picker endpoints let you retrieve the building blocks (specializations, training modules, and tags) that are referenced when building or triggering workflow automations programmatically. All workflow picker endpoints require authentication. Responses are always scoped to the active organization and filtered to published records only.

Workflow trigger types

Workflows in PartnerOS can be triggered by the following events. These trigger types are defined in the workflow schema and are used when creating workflows through the workflow builder:

Trigger type	Description
`partner_created`	Fires when a new partner record is created.
`partner_joined_platform`	Fires when a partner completes the partner portal onboarding.
`deal_registered`	Fires when a deal registration is submitted.
`deal_registration_approved`	Fires when a deal registration is approved.
`deal_registration_declined`	Fires when a deal registration is declined.
`application_submitted`	Fires when a partner application form is submitted.
`partner_stage_changed`	Fires when a partner’s lifecycle stage changes.
`partner_agreement_signed`	Fires when a partner signs an agreement.
`partner_certification_completed`	Fires when a partner completes a certification.
`partner_tier_changed`	Fires when a partner’s tier is updated.
`mdf_request_submitted`	Fires when a market development fund request is submitted.
`contract_renewal_approaching`	Fires on a schedule before a contract renewal date.
`partner_inactive`	Fires when a partner is flagged as inactive.
`deal_closed_won`	Fires when a deal is marked closed-won.
`deal_closed_lost`	Fires when a deal is marked closed-lost.
`partner_payment_made`	Fires when a partner payment is recorded.
`contact_added_to_partner`	Fires when a contact is linked to a partner.
`manual`	No automatic trigger; the workflow is invoked on demand.

List specializations

Returns all published enablement specializations for your organization, ordered alphabetically by title. Specializations are used in workflow builders to target training programs at specific partner competency tracks. GET /api/workflow-pickers/specializations

Response fields

object[]

required

Array of published specialization records.

Show specialization fields

string

UUID of the specialization.

string

Display title of the specialization (e.g. "Cloud Infrastructure").

Example

curl --request GET \
  --url "https://app.partneros.com/api/workflow-pickers/specializations" \
  --header "Content-Type: application/json" \
  --header "Cookie: session_token=<your-session-token>"

{
  "specializations": [
    {
      "id": "spec_01hx...",
      "title": "Cloud Infrastructure"
    },
    {
      "id": "spec_02hx...",
      "title": "Data & Analytics"
    },
    {
      "id": "spec_03hx...",
      "title": "Security & Compliance"
    }
  ]
}

This endpoint returns only specializations with isPublished = true. Draft specializations are excluded.

List training modules

Returns all published training modules for your organization, ordered alphabetically by title. Training modules represent individual learning units that can be assigned to partners as steps in a workflow automation. GET /api/workflow-pickers/trainings

Response fields

object[]

required

Array of published training module records.

Show training fields

string

UUID of the training module.

string

Display title of the training (e.g. "Partner Onboarding Fundamentals").

Example

curl --request GET \
  --url "https://app.partneros.com/api/workflow-pickers/trainings" \
  --header "Content-Type: application/json" \
  --header "Cookie: session_token=<your-session-token>"

{
  "trainings": [
    {
      "id": "train_01hx...",
      "title": "Deal Registration Essentials"
    },
    {
      "id": "train_02hx...",
      "title": "Partner Onboarding Fundamentals"
    },
    {
      "id": "train_03hx...",
      "title": "Sales Enablement Certification"
    }
  ]
}

List training tags

Returns a deduplicated, sorted list of all tags that appear on your organization’s published training modules. Tags are used in workflow builders to filter or target training assignments by topic or audience. GET /api/workflow-pickers/training-tags

Response fields

string[]

required

Alphabetically sorted array of unique tag strings drawn from all published trainings.

Example

curl --request GET \
  --url "https://app.partneros.com/api/workflow-pickers/training-tags" \
  --header "Content-Type: application/json" \
  --header "Cookie: session_token=<your-session-token>"

{
  "tags": [
    "certification",
    "compliance",
    "deal-registration",
    "onboarding",
    "sales-enablement",
    "technical"
  ]
}

PPTX export stream

Streams progress for a premium PowerPoint export of an enablement lesson. Connect to this Server-Sent Events (SSE) endpoint after dispatching an export action. The server polls at 1.5-second intervals and emits a completed event as soon as the generated file is ready. GET /api/exports/pptx/stream This endpoint returns Content-Type: text/event-stream. Keep the connection open until you receive a completed or error event. A hard timeout of 5 minutes applies; after that the server emits an error event and closes the stream.

Query parameters

string

required

UUID of the enablement lesson whose PPTX export you are waiting for.

string

Optional cache key for the export job. When provided, the server only emits completed for an export whose cache key matches. Omit to accept any fresh export for the lesson.

SSE events

Event	Description
`completed`	The PPTX file is ready. The `data` object contains `url`, `costCents`, and `model`.
`error`	Export failed or timed out. The `data` object contains a `message` field.
`:hb`	Heartbeat comment emitted every 15 seconds to keep the connection alive.
`: connected`	Emitted immediately on connection to confirm the stream is open.

Example

curl --request GET \
  --url "https://app.partneros.com/api/exports/pptx/stream?lessonId=lesson_01hx..." \
  --header "Accept: text/event-stream" \
  --header "Cookie: session_token=<your-session-token>"

: connected

:hb

:hb

event: completed
data: {"url":"https://storage.example.com/exports/lesson_01hx...pptx","costCents":4,"model":"claude-sonnet-4-5"}

In JavaScript, consume this endpoint with the browser EventSource API or a Node.js eventsource library. Parse the data field of each event as JSON.

Overview

Endpoints

Workflows API — trigger and manage partner automations

Workflow trigger types

List specializations

Response fields

Example

List training modules

Response fields

Example

List training tags

Response fields

Example

PPTX export stream

Query parameters

SSE events

Example

​Workflow trigger types

​List specializations

​Response fields

​Example

​List training modules

​Response fields

​Example

​List training tags

​Response fields

​Example

​PPTX export stream

​Query parameters

​SSE events

​Example

Workflow trigger types

List specializations

Response fields

Example

List training modules

Response fields

Example

List training tags

Response fields

Example

PPTX export stream

Query parameters

SSE events

Example