KOkombo
Kombo Connect

Activate integration (optional)

Changed on

Use this endpoint with the token you get from the connection flow to retrieve information about the created integration. It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user. You do not need to call this endpoint for an integration to become active.

<Warning>We are deprecating this endpoint in favour of the get integration by code endpoint. To migrate you only have to change to the new API endpoint.</Warning>

Example Request Body

{
  "token": "<example-token>"
}
post/connect/activate-integration

Request

Request body

tokenstring required

Response

POST /connect/activate-integration Positive response

status'success' required

Example response

{
  "data": {
    "tool": "personio",
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "end_user_origin_id": "36123",
    "end_user_organization_name": "Acme, Inc.",
    "end_user_email": "user@example.com",
    "setup_status": "COMPLETED"
  }
}

Changes

  • d0e06abf1118Revision changes
    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the / response's property type changed from string to string null, and format from email to no format for status

    • warning

      removed subschema #1 from the request body allOf list

    • info

      removed the non-success response with the status

    • info

      the response property const value success was added for the status

    • info

      removed the success enum value from the response property for the response status

    • info

      the / response's property pattern ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$ was added for the status

    • info

      added the required property / to the response with the status