NEnectarhr
Flows

Trigger a Flow for specified users

Enrolls users in a Flow via an API trigger. Users can be identified by email or userId. All specified users must be valid members of the company associated with the API key. If any users are not found, the request will fail without enrolling any users.

post/v1/flows/trigger/{triggerId}

Request

  • Base URL
    https://api.nectarhr.com
  • URL
    https://api.nectarhr.com/v1/flows/trigger/{triggerId}
  • Auth
    HTTP bearer

Path parameters

triggerIdstring required

The ID of the API trigger to invoke

Request body

OR

Response

Users enrolled successfully

status'success'

Changes

No recorded changes to this operation across all 5 revisions of this API.