Pulses

A Pulse is an automated report delivery service that makes it easy to stay updated without having to manually check your reports. You can set up Pulses for any of your reports, choosing how often you’d like to receive them — whether it's daily, weekly, bi-weekly, or monthly. This way, important data arrives straight to your inbox or Slack, keeping you informed at your preferred schedule.

Email recipients are managed in two ways:

  • Memberships: link existing Productive users or teams to a pulse (done via the memberships endpoint).
  • recipients attribute: specify additional email addresses that are not linked to any user in the app.

More about Pulses in our help center

Attributes

creator person
Response

The person who created this pulse.
creator_id integer
Parameter `filter`

The ID of the person who created this pulse.
deactivated_at string
Response

Timestamp when the pulse was deactivated, or null if still active.
document_format_id integer
Response Request Enum

The ID of the document format used when exporting the report.

Enum Values (3 values)

  • 1
    pdf
  • 2
    csv
  • 3
    xlsx
export_params object
Response Request

Export configuration parameters for the report attached to this pulse.
filter filter
Response

The saved filter (report) delivered by this pulse.
filter_id integer
Request Parameter `filter`

The ID of the saved filter (report) delivered by this pulse.
id integer
Parameter `filter`

Unique identifier for the pulse.
memberships array of membership
Response

The memberships (recipients) that have access to this pulse.
organization organization
Response

The organization this pulse belongs to.
recipients object
Response Request

Email addresses of recipients who receive this pulse delivery.
repeat_schedule_id integer
Response Request Enum

The ID of the repeat schedule setting (e.g. daily, weekly, monthly).

Enum Values (5 values)

  • 1
    Daily
  • 2
    Weekly
  • 3
    Monthly
  • 4
    Yearly
  • 5
    Biweekly
schedule_day_id integer
Response Request Enum

The ID of the day within the repeat schedule on which the pulse is sent.

Enum Values (7 values)

  • 1
    Monday
  • 2
    Tuesday
  • 3
    Wednesday
  • 4
    Thursday
  • 5
    Friday
  • 6
    Saturday
  • 7
    Sunday
schedule_frame_id integer
Response Request Enum

The ID of the schedule frame (e.g. this week, last month) for the report period.

Enum Values (3 values)

  • 1
    First
  • 2
    Last
  • 3
    Middle
schedule_hour integer
Response Request

The hour of the day (0-23) when the pulse is sent.
skip_if_empty boolean
Response Request

When true, the pulse is not sent if the report contains no data.
slack_channel string
Response Request

The Slack channel where this pulse is delivered, if configured.
subscriber_id integer
Parameter `filter`

ID of the person subscribed to receive this pulse.
teams_channel string
Response Request

The Microsoft Teams channel name within the team where pulse notifications are delivered.
teams_team string
Response Request

The Microsoft Teams team name where pulse notifications are delivered.
test_pulse boolean
Response Request

When true, this is a test pulse used for previewing output without sending to real recipients.
type_id integer
Response Request Enum

ID of the pulse delivery type (email, Slack, or Microsoft Teams).

Enum Values (3 values)

  • 1
    Email
  • 2
    Slack
  • 3
    Teams
version integer
Request

The version number of this pulse configuration, incremented on each update.

Operations

GET /api/v2/pulses
Get pulses
POST /api/v2/pulses
Creates a pulse
DELETE /api/v2/pulses/{id}
Deletes a pulse
GET /api/v2/pulses/{id}
Gets a pulse
PATCH /api/v2/pulses/{id}
Updates a pulse
PATCH /api/v2/pulses/{id}/send
Send a pulse