Overview
The Fieldguide API allows you to build custom integrations between the Fieldguide platform and other software applications.
The Fieldguide API is available to enterprise users. Contact [email protected] for more information.
Fieldguide also provides webhooks which can be used to alert a partner system when a certain event occurs in Fieldguide, like an engagement being created or a request being completed. This allows developers to create custom integrations that instantly trigger actions in other tools.
See the Fieldguide API documentation for developers.
Create an API token
To provision an API token, log into a Fieldguide account.
The permissions of the token will be limited to the permissions of the account used to create this token.
Go to My Profile > Integrations.
Click +Add custom integration. Enter a name and expiration date, and define the scopes you'd like your token to have.
Copy the token to your clipboard and save it in a secure location. The token will not be accessible once you close this menu.
For security purposes:
Tokens expire up to 1 year from the time the token is generated. Expiration defaults to 90 days but can be set when the token is created.
Tokens are scoped to grant partner systems access to certain activities & objects by the user creating them.
Tokens must be encrypted whenever they are stored in partner systems to prevent data leaks and security vulnerabilities.