Back

Process Street API Essential Guide

Aug 15, 20246 minute read

What type of API does Process Street provide?

Based on the search results provided, I do not have any specific information about what type of API Process Street uses (e.g. REST, GraphQL, SOAP). The search results do not mention Process Street or its API.

To answer this question accurately, we would need to consult Process Street's official API documentation or developer resources. Without that information, I cannot make a definitive statement about what type of API Process Street implements.

The most common modern API types are REST, GraphQL, and SOAP, with REST being the most widely adopted currently. Many companies, especially newer SaaS platforms, tend to offer REST APIs due to their flexibility and ease of use. To determine Process Street's API type, we would need to check their developer documentation or contact their support team directly.

Always refer to a company's official API documentation for the most accurate and up-to-date information about their API implementation. If the API type is not clearly stated, look for clues in the documentation such as endpoint structures, data formats, and authentication methods which can indicate the API type. When in doubt, reach out to the company's developer support channels for clarification on their API architecture.

Does the Process Street API have webhooks?

Availability of Webhooks

Yes, the official Process Street API does have webhooks available.

Types of Events You Can Subscribe To

Process Street offers both outgoing webhooks and incoming webhook triggers.

For outgoing webhooks, you can subscribe to the following events:

  • When tasks are checked/unchecked
  • When a workflow run is created
  • When a workflow run is completed
  • When a task is ready to be checked
  • When a task is not ready to be checked
  • When a task is approved
  • When a task is rejected
  • When a record is added to a data set
  • When a record is updated in a data set
  • When a record is deleted from a data set

For incoming webhook triggers, you can set up a workflow to run automatically when an event occurs in another connected app.

Key Points

  • Webhooks allow event-driven messages to be sent between Process Street and other apps.
  • Outgoing webhooks notify other services about events in Process Street.
  • Incoming webhook triggers allow running workflows in Process Street based on events in other apps.
  • Webhook payloads contain data about the triggering event that can be used for automation.
  • Administrators can set up outgoing webhooks, while Members with edit permissions can set up incoming webhook triggers.

Best Practices

  • Use JSON format for webhook payloads when configuring in other apps.
  • Map incoming webhook fields to Process Street form fields to populate data.
  • Test webhooks by triggering sample events and checking the payload.
  • Use webhooks to build automations between Process Street and other systems.

In summary, Process Street offers robust webhook functionality for both sending out notifications and triggering workflows, allowing for powerful integrations and automations with other tools and systems.

Rate Limits and other limitations

Based on the search results provided, there is no specific information about the API rate limits for the Process Street API. However, I can provide some general information about API rate limiting and best practices:

Key Points to Consider

  • API rate limiting is an important practice to control the number of requests a client can make to an API within a specified timeframe [5].

  • Rate limiting helps ensure fair usage, prevent abuse, and maintain stability and performance of the API [5].

  • Common rate limiting strategies include fixed window, sliding window, and token bucket algorithms [5].

Best Practices for API Rate Limiting

  1. Choose the appropriate rate limiting strategy based on your API's needs and expected traffic patterns [5].

  2. Set effective rate limits that balance accommodating legitimate usage while preventing abuse [5].

  3. Provide clear and informative error messages when rate limits are exceeded [5].

  4. Implement monitoring and analytics to track API usage and fine-tune rate limiting parameters [5].

  5. Consider using server-side rate limiting for stronger protection and consistent enforcement across all clients [5].

Implementing Rate Limiting

While we don't have specific information about Process Street's implementation, here are some general approaches:

  1. Fixed Window Strategy: Set a predetermined time window during which the rate limit is enforced (e.g., 100 requests per minute) [5].

  2. Sliding Window Strategy: Track requests over a rolling timeframe for more dynamic rate limiting [5].

  3. Token Bucket Algorithm: Allocate tokens to clients based on their request frequency, allowing for more flexible rate limiting [5].

Conclusion

Without specific information about Process Street's API rate limits, it's best to consult their official documentation or contact their support for accurate details. When implementing or using APIs, it's important to be aware of rate limiting practices and adhere to the limits set by the API provider to ensure fair usage and maintain system stability.

Latest API Version

Based on the search results provided, here is the most up-to-date information about the Process Street API:

The most recent version of the Process Street API was updated on May 10, 2024 [1]. The API allows users to run workflows, update workflow runs and data sets without needing third-party integration tools [1].

Key points to consider:

  1. The API uses an API key for authentication, which can be generated from the integrations page in the organization manager area [1][4].

  2. Only Process Street admins can create and manage API keys [4].

  3. The API provides various endpoints for actions like finding workflow runs, getting user information, updating workflow runs, and more [2][4].

  4. The API is available for use with Logic Apps, Power Automate, and Power Apps, with some regional limitations [4].

  5. There are currently no known issues or common errors reported for the Process Street connector [4].

Some example API endpoints include:

  • List all Workflows
  • List of all form fields by Workflow ID
  • List/find Workflow runs by name or form field value
  • List tasks by Workflow ID
  • List users
  • Assign user to Workflow run
  • Unassign user from Workflow run [2]

To use the API, you need to have a Process Street account. If you don't have one, you can sign up for a free 14-day trial [4].

In summary, the Process Street API provides a robust set of tools for automating and integrating Process Street functionalities into your workflows. It's regularly updated and offers a wide range of capabilities for managing workflows, users, and tasks programmatically.

How to get a Process Street developer account and API Keys?

To get a developer account for Process Street to create an API integration, you need to follow these steps:

1. Sign up for a Process Street account

If you don't already have a Process Street account, you'll need to sign up for one. You can start with a free 14-day trial.

2. Become an administrator

To create and manage API keys, you need to have administrator privileges in your Process Street organization.

3. Generate an API key

Once you have an administrator account:

  1. Go to the 'Organization' settings in Process Street.
  2. Navigate to the 'Integrations' tab.
  3. Look for the option to create a new API key.
  4. Generate and name your new API key.

Key points to consider:

  • Only Process Street administrators can create and manage API keys.
  • It's best practice to change the default label of your API key (e.g., from "API Key #1" to something more descriptive like "Power Automate").
  • The name of your API key will appear in notification emails sent to provisioned users, so choose a clear and appropriate name.

Using the API key

Once you have generated your API key, you can use it to authenticate your requests to the Process Street API. The API key should be included in the headers of your API requests, typically like this:

headers: {
  "X-API-KEY": "your_api_key_here"
}

Best practices

  1. Keep your API key secure and don't share it publicly.
  2. Use different API keys for different integrations or purposes to maintain better control and security.
  3. Regularly review and rotate your API keys as part of your security practices.

What can you do with the Process Street API?

Based on the search results provided, here is a list of data models you can interact with using the Process Street API, along with what is possible for each:

Workflows

  • Create new workflows
  • Update existing workflows
  • Retrieve workflow information

Workflow Runs

  • Start new workflow runs
  • Update workflow runs
  • Retrieve workflow run information
  • Check when a workflow run is completed

Tasks

  • Add tasks to workflows
  • Update task information
  • Check when a task is completed

Data Sets

  • Create and update data sets
  • Retrieve data set information

Forms

  • Create and update forms
  • Retrieve form data

Checklists

  • Create new checklists
  • Retrieve checklist information

Organizations

  • Manage API keys associated with organizations

Users

  • Manage user information (limited details provided)

Integrations

  • Connect Process Street with other applications (though many integrations rely on third-party tools like Zapier)

Analytics

  • Retrieve analytics data (limited details provided)

It's important to note that while these data models are mentioned in the search results, the specific operations available for each may vary. The Process Street API documentation would provide more detailed information on the exact endpoints and operations available for each data model.