Skip to content

Custom APIs and tokens

Use this path when a service provides an API but does not have a dedicated setup guide. You will need its API documentation and permission to use the required account.

Before you start

Find:

  • The provider’s API documentation.
  • The action you need, such as reading an order or creating a contact.
  • The required credential, such as an API key or bearer token.
  • The account, environment, and record you will test with.

If the provider uses OAuth, check the integration directory for its connection flow first.

1. Describe the API task

Give Neudash the documentation link and describe the input and expected result. Identify whether the process should read data, change it, or both.

For example: “Read an order by its ID and return its current status. Start with this test order.”

2. Save the credential

Use the configuration type requested for the integration. Enter the credential in its secret field and give the configuration a name that identifies the account or environment.

Keep credentials out of process code, chat messages, and sample inputs. Refer to the saved configuration when describing which account the process should use.

3. Check one request

Start with a small request whose result you know. For a read, compare the returned data with the record in the source system.

Before testing a write, check the target account and the exact change. Use a test record when the service provides one.

4. Connect it to the process

Once the request works, use the saved configuration in the process. Check required input fields, pagination, rate limits, and error responses against the provider’s documentation.

Choose when the process should run separately. Saving an API credential does not create an event trigger.

If the request fails

ResultCheck
Authentication rejectedThe credential, account, expiry, and required authentication format.
Access deniedThe credential’s permissions and the account’s access to that record.
Record not foundThe API environment, endpoint, and record identifier.
Rate limit reachedThe provider’s limit and retry guidance.
Unexpected outputThe response fields and pagination in the current documentation.

Keep the provider’s error message and request identifier when asking for help. Remove credentials and private record data from anything you share.