API Operations

Operations represent each individual thing you can do with a connected application, like:

• Get a list of users
• Send a message
• Delete a task
• ...etc

Each operation has the following structure:

• key – a unique identifier for the operation. You can use this to reference the operation in your code.
• name – human-readable name of the operation. You can display it to your users.
• description – detailed description of the operation in Markdown format.
• tags – a list of strings that can be used to categorize operations.
• inputSchema – a Data Schema describing the operation input.
• outputSchema – a Data Schema describing the operation output.
• 
  

Getting a list of operations

To get a list of operations supported by a given integration, run the following code:

await integrationApp
  .integration('hubspot')
  .getOperations()

Getting details of a single operation

To get specification of a single operation, run the following code:

await integrationApp
  .integration('hubspot')
  .getOperation('{OPERATION_KEY}')

Running an operation

To run an operation for a specific connection, run the following code:

await integrationApp
  .connection('hubspot')
  .operation('{OPERATION_KEY}')
  .run()