Authenticate requests to the Email API using your API key and secure credentials. Maintain key hygiene, rotate secrets periodically, and test in a sandbox before going live to protect student data and certificate workflows.
Configure Rankr to securely store the Email API key and establish a trusted connection. Use vaults or protected environment variables and verify credentials with a small test call.
Available endpoints used in this integration: – POST /users/ creates a user – DELETE /users/:userId deletes a user – PUT /users/:userId updates a user – GET /workflows/ lists workflows – POST courses/courses-exporter/public/import imports a course for Accredible syncing
Trigger: When a new student signs up in Rankr, create the corresponding user in the Email API using POST /users/.
Actions: Create the user, set initial status, and link to the Accredible certificate workflow.
Method path: POST /users/
Key fields: email, fullName, role to map to Accredible user records.
Trigger: When Rankr triggers a certificate action, start or update an Email API workflow (via GET /workflows/ and related calls).
Actions: Initiate or update a workflow, tie to certificateId, and push status updates back to Rankr.
Method path: GET /workflows/ (to fetch) and POST as needed to start a workflow.
Key fields: workflowId, certificateId, status.
Trigger: When a course is updated in Rankr, import/update via POST /courses/courses-exporter/public/import.
Actions: Create or update course records, sync enrollments and outcomes with Accredible.
Method path: POST /courses/courses-exporter/public/import
Key fields: courseName, courseId, enrollments.
Automate certificate issuance without manual data entry, saving time and reducing errors.
Keep data synchronized across your LMS, CRM, and Accredible for consistent reporting.
Gain real-time visibility with status updates and automated alerts for admins and students.
This glossary defines key terms used in the integration, including API, endpoint, webhook, and OAuth.
Definition: A set of rules and protocols that allow different software applications to communicate and share data.
Definition: A user-defined HTTP callback that triggers when a specific event occurs in an integrated service.
Definition: A specific URL in an API that represents a resource or collection you can access or modify.
Definition: An authorization framework that lets apps obtain limited access tokens to perform actions on behalf of a user.
Automatically enroll users in Accredible certificates when Rankr triggers a course completion, reducing manual steps.
Send live notifications to admins when certificates are issued, updated, or failed, enabling faster remediation.
Schedule periodic bulk syncing of courses and enrollments to keep Accredible in sync with Rankr.
Create an API key in the Email API and store it securely in Rankr. Use a vault or environment variables with restricted access.
Map Rankr fields to Email API endpoints so data flows correctly between systems and Accredible.
Test in a sandbox, verify success criteria, then monitor activity and error logs after going live.
Authentication is typically done with an API key that you securely store in Rankr. Rotate keys regularly and limit permissions to the minimum scope needed (users.write for most certificate tasks). If available, use sandbox credentials to validate before going live. Always follow your organization’s security policies when handling credentials and data.
The core endpoints used for Accredible certificates with Rankr include creating and updating users (POST /users/, PUT /users/:userId), deleting users (DELETE /users/:userId), listing workflows (GET /workflows/), and importing course data (POST courses/courses-exporter/public/import). Only these endpoints are required for the basic flow; others can be added as your needs grow.
Yes. You can test in a sandbox environment provided by the Email API. Use test data and simulate certificate issuance to verify end-to-end behavior without impacting real records. Monitor responses and adjust mappings accordingly.
Field mappings should align Rankr user fields (email, name, role) to the Email API user object, and certificate/workflow identifiers to Accredible-related records. Start with a minimal mapping and expand as you validate data integrity and error handling.
If an API key is compromised, immediately revoke the key, rotate credentials, and audit recent activity. Re-issue keys with restricted scopes and update all integration points to use the new credentials.
Yes. While you can implement most flows with code, you can often achieve core automation with no-code tools by triggering API calls from Rankr workflows and using webhooks for real-time updates.
Status and logs can be monitored in the Email API dashboard and Rankr’s integration logs. Set up alerts for failures, retries, and successful synchronizations to keep your team informed.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
