COconvoy
integration

Retrieve the current status of a broker integration

Retrieve the current status of a broker integration.

get/integration/brokerIntegrationStatus

Request

  • Base URL
    https://demo-developer.convoy.com/broker
  • Auth
    HTTP bearer

Query parameters

integratorBrokerIdstring required

Headers

X-Convoy-API-Versionstring required

The Convoy API version

Response

The request has succeeded.

status'PENDING' | 'CONFIRMED' | 'CANCELED' | 'VERIFICATION_FAILED' | 'ACTIVATED' | 'DEACTIVATED' required

The status of the broker integration request

StatusDescription
PENDINGThe integration request was created and is pending confirmation by a broker admin and broker account verification by Convoy.
VERIFICATION_FAILEDThe Convoy broker account did not pass the verification stage (failed one or more checks).
CONFIRMEDThe integration request was confirmed by a broker admin. The broker account is still pending verification by Convoy.
CANCELEDThe integration request was canceled. The broker may submit another integration request.
ACTIVATEDThe integration was approved by the broker and client credentials have been created for the integrator to use.
DEACTIVATEDConvoy broker integration was deactivated. Any credentials associated with this broker integration cannot be used to access the Convoy API.

Changes

No recorded changes to this operation across all 1 revision of this API.