API - Getting started

The CSRconnect API allows your community to connect and interact with CSRconnect.

Sample use cases include:

• Creating in-app dashboards for CSRconnect.

• Updating your intranet with year-to-date (YTD) charitable donations and matches.

• Adding a widget to your employees’ Workday environment to show individual and company matching donations.

• Creating individualized My Giving home pages to show employees their own statistics for giving and volunteering. Providing a direct link to their respective CSRconnect page allows them to update it as well.

• Creating, updating, registering, and recording participation for company-sponsored volunteer event programmatically.

We have a variety of APIs that allow you retrieve information on:

• Specific employes

• Employee groups

• Metrics for employees, volunteer events, giving campaigns, donations to specific charities, etc.

• Volunteer events, including creating, editing, and deleting them using APIs

• Custom questionnaire responses

See our information on Swagger at https://api.yourcause.com/swagger/index.html.

Our sample Postman collection with example API calls is available for download. To use it, set up your Postman environment to include:

• The base URL of the environment you’re trying to connect to:

  • Production: https://api.yourcause.com

  • Test: https://api.yourcauseuat.com

• Your API key in that environment (xbbkey)

• Your internal AffiliateID in our system. If you don’t know what it is, reach out to our support team or your Customer Success Manager and we can provide it.

• A sample employee email address for a valid employee in that environment.

After creating the environment in Postman, options include:

• Running the whole collection to see all results.

• Opening a specific API endpoint and selecting Send to see the result for that API endpoint.

Completing API setup requirements

To use this API, your community must:

1. Obtain a valid API key.

2. Be an existing customer.

Generating a new external API key

To generate a new external API key:

1. Log in to the CSRconnect Admin Portal.

2. Navigate to Integrations, External API Keys.

3. Select Create API Key.

4. Enter a name for the API key.

5. Indicate the expiration period and all applicable client services.

6. Select Save.

7. On the External API Keys page, select Show Key beneath the key listing.

8. Copy the key listed in the Key field.

9. Include this key in a header variable named x-bb-key for each request using the external API to link to CSRconnect.

For more information on the CSRconnect external API, see External API Swagger.