Skip to main content

Setup Checklist

Complete these before calling the API in production. Work with your JOFI representative for account setup items.

Credentials​

  • Live API key (sk_live_...): creates real records. See API Keys.
  • Test API key (sk_test_...): returns fake responses; use for development. See API Keys.
  • API key stored securely: do not commit keys to source control or expose them in client-side code.

Account structure​

  • At least one team: invitations are scoped to a team. See Teams.
  • At least one user: you must pass a created_by_user_email when creating invitations. See Users.
  • Inviter belongs to your account: the created_by_user_email user must be on the same account as your API key.

Inviter defaults​

Configure these JOFI user settings for every user who will send invitations via the API. They are strongly recommended. If a user is missing a default, set it up in JOFI unless you have business rules that require you to pass team_id, assessments_to_assign, or email_template_id on each request.

  • Default team for each inviter
  • Default assessments for each inviter
  • Default invitation email template for each inviter

Use GET /users to verify each inviter's defaults before going live. Use GET /email-templates to look up valid email template IDs. Use GET /accounts to check your configured live webhook endpoint.

The API accepts override fields when needed, but user defaults should be your primary approach. See Create Invitation for the full request reference.

Webhooks (optional)​

Webhooks are optional, but they are a great way to integrate with JOFI because JOFI pushes updates to your system as participants progress. Instead of polling GET routes, your webhook handler can react when invitations are accepted, assessments are completed, and career navigation profiles are created.

  • Live webhook endpoint: receives automatic production events (invitation.created, test_taker.assessment_completed, and so on)
  • Test webhook endpoint: optional URL for verifying your handler. Automatic events are not sent here. Ask a JOFI Admin to send test events to this endpoint when you want to validate your integration.

See Webhooks and Events for setup, verification, and the full list of event types.

Recommended

Ask your JOFI representative to send you an invitation so you can walk through the participant experience on JOFIscore.com and CareerNavigation.org before going live.