Complete plugin OAuth flow

POST

/api/v1/plugin-system/oauth/callback

const url = 'https://example.com/api/v1/plugin-system/oauth/callback';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"instanceId":"example","code":"example","state":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/plugin-system/oauth/callback \
  --header 'Content-Type: application/json' \
  --data '{ "instanceId": "example", "code": "example", "state": "example" }'

Exchanges an OAuth authorization code and stores the resulting plugin credentials.

Request Body^required

application/json

object

instanceId

required

string

code

required

string

state

required

string

Example^generated

{
  "instanceId": "example",
  "code": "example",
  "state": "example"
}

Responses

200

OAuth callback handled

application/json

object

boolean

Example^generated

{
  "ok": true
}

400

Bad Request

401

Unauthorized

500

Internal Server Error

Complete plugin OAuth flow

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

400

401

500

Request Body^required

Example^generated

Example^generated