Skip to content

Onboarding: Update to API credentials #706

@shijithkjayan

Description

@shijithkjayan

Is your feature request related to a problem?
The recent update to the onboarding API changed the format for saving OpenAI credentials, which was not clearly communicated to partners. As a result, 36 newly onboarded NGOs have missing API keys, preventing them from utilizing AI assistants in Glific.

Describe the solution you'd like

  • Provide clear documentation regarding the new credentials format to partners.
  • Implement a fix to ensure that OpenAI API credentials are correctly saved in the new structured array format during onboarding.
  • Notify all affected NGOs about the issue and provide guidance on how to resolve it.
Original issue

Describe the bug
In the first week of February, the onboarding API was updated to support a structured credentials format. Previously, credentials were passed as flat fields:

  {
    "openai_api_key": "sk-proj-..."
  }

The new format expects credentials in a structured array:

  {
    "credentials": [
      {
        "openai": {
          "api_key": "sk-proj-..."
        }
      }
    ]
  }

This change was made to allow users to provide all required credentials during onboarding, eliminating the need for a separate call to the Create Credential API. However, the change was not communicated clearly to partners at the time of deployment, causing the old flat format to be silently ignored.

Impact

  • Affected organizations: 36 newly onboarded NGOs in Glific
  • Onboarding status: All 36 NGOs were successfully onboarded to both Glific and Kaapi
  • Missing data: OpenAI API credentials were not saved during onboarding due to the format mismatch
  • User-facing consequence: These NGOs are unable to create or use AI assistants in Glific, as the OpenAI integration requires the API key to be present

Additional context
Add any other context about the problem here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Closed

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions