Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 7.85 KB

File metadata and controls

25 lines (13 loc) · 7.85 KB

Orbit Actions

Activities Actions:

Action NameDescriptionParametersAdditional Details
List Orbit Activities for WorkspaceList activities for a workspace- workspace_slug (required)Retrieve a list of activities associated with a specific workspace in Orbit.
Create Custom ActivityCreate custom activity for a member- workspace_slug (required) - json_body (required)Create custom activities for new or existing members. Use json_body to specify activity details.
Create Content ActivityCreate content-related activity for member- workspace_slug (required) - json_body (required)Create content-related activities for members. Specify activity details using json_body.
Get Activity by IDRetrieve activity by ID- workspace_slug (required) - activity_id (required)Get a specific activity in Orbit by providing its ID.
Get Activity by MemberGet activities by member- workspace_slug (required) - member_slug (required)Retrieve activities associated with a specific member in Orbit.
Create Custom Activity for MemberCreate custom activity for member- workspace_slug (required) - member_slug (required) - json_body (required)Create custom activities for a specific member. Specify activity details using json_body.
Create Content Activity for MemberCreate content-related activity for member- workspace_slug (required) - member_slug (required) - json_body (required)Create content-related activities for a specific member. Specify activity details using json_body.
Delete Activity on MemberDelete activity associated with member- workspace_slug (required) - member_slug (required) - activity_id (required)Delete a specific activity associated with a member in Orbit.
List Activities by OrganizationList activities for an organization- workspace_slug (required) - organization_id (required)Retrieve activities for a specific organization within a workspace.
List Activity TypesList available activity types- workspace_slug (required)List the available activity types within a workspace in Orbit.

Members Actions:

Action NameDescriptionParametersAdditional Details
List Orbit MembersList members in a workspace- workspace_slug (required)List members in a specific workspace. Provides member details such as name, company, location, and more.
Add Identity to MemberAdd an identity to a member- workspace_slug (required) - member_slug (required) - json_body (required)Add an identity (e.g., email, GitHub, Twitter) to a member in Orbit. Specify identity details using json_body.
Delete Identity from MemberRemove an identity from a member- workspace_slug (required) - member_slug (required) - json_body (required)Remove an identity from a member in Orbit. Specify identity details using json_body.
Create or Update MemberCreate or update member information- workspace_slug (required) - json_body (required)Create a new member or update existing member information in Orbit. Specify member details using json_body.
Get MemberRetrieve member information- workspace_slug (required) - member_slug (required)Retrieve detailed information about a specific member in Orbit.
Delete MemberDelete a member from Orbit- workspace_slug (required) - member_slug (required)Delete a member from Orbit.
Find Identity by MemberFind identities associated with a member- workspace_slug (required) - json_body (required)Find identities (e.g., email, GitHub, Twitter) associated with a specific member in Orbit. Specify search criteria using json_body.
List Members in OrganizationList members in an organization- workspace_slug (required) - organization_id (required)List members within a specific organization in Orbit.

Notes Actions:

Action NameDescriptionParametersAdditional Details
Create NoteCreate a note for a member- workspace_slug (required) - member_slug (required) - json_body (required)Create a note associated with a specific member in Orbit. Specify the note content using json_body.
Get Member NotesRetrieve member's notes- workspace_slug (required) - member_slug (required)Retrieve notes associated with a specific member in Orbit.
Update NoteUpdate an existing note- workspace_slug (required) - member_slug (required) - note_id (required) - json_body (required)Update an existing note associated with a member in Orbit. Specify the updated note content using json_body.

Organizations Actions:

Action NameDescriptionParametersAdditional Details
List Organizations in WorkspaceList organizations in a workspace- workspace_slug (required)List organizations within a specific workspace in Orbit.
Get OrganizationRetrieve organization information- workspace_slug (required) - organization_id (required)Retrieve detailed information about a specific organization in Orbit.

Reports and User Actions:

Action NameDescriptionParametersAdditional Details
Get Workspace StatsRetrieve workspace statistics- workspace_slug (required)Get statistics for a workspace in Orbit.
Get Current UserRetrieve information about the current user- NoneGet information about the current user in Orbit.

Generic API Request Action:

Action NameDescriptionParametersAdditional Details
Orbit API RequestGeneric action for making authenticated requests- workspace_slug (required) - Various request parametersPerform custom authenticated requests against the Orbit API. Allows flexibility in interacting with the API for specific use cases.