Create or update installed integration base notifier

This endpoint is used to create or update an installed integration base notifier.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{clientId}/integrations/installed/{installedIntgId}/notifier

Sample URLs

https://{api-url}/api/v2/tenants/client_398/integrations/installed/INTG-30afec31-9c37-4784-a6de-051997a5715e/notifier

Parameters

All fields are mandatory:

FieldData TypeDescription
typeStringNotifier type.
authTypeStringAuthentication type: NONE, OAUTH2.
authTypeStringSecurity credentials are CLIENT_CREDENTIALS, PASSWORD, REFRESH_TOKEN.
Example: PASSWORD
userNameStringThe user name.
passwordStringPassword.
apiKeyStringAPI key.
apiSecretStringAPI secretMandatory when authType is OAUTH2.
accessTokenURIStringAccess token URIMandatory when authType is OAUTH2.

The SOAP API supports only NONE authentication types.

Status code

200 OK

Create or update notifier with authentication type NONE

This is a sample request to create or update a notifier with authType NONE and sample response generated that creates a notifier.

Sample request

{
	"type": "SOAP API",
	"baseURI": "www.google.com",
	"authType": "NONE"
}

Sample response

{
	"baseURI": "www.google.com",
	"authType": "NONE"
}

Create or update notifier with authentication type OAUTH2 and grant type CLIENT_CREDENTIALS

This is a sample request to create or update a notifier with OAUTH2 and Grant Type CLIENT_CREDENTIALS. The sample response creates a notifier.

Sample request

{
	"type": "REST_API",
	"baseURI": "www.google.com",
	"authType": "OAUTH2",
	"grantType": "CLIENT_CREDENTIALS",
	"accessTokenURI": "www.token.com/cred",
	"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
	"apiSecret": "**********************"
}

Sample response

{
	"baseURI": "www.google.com",
	"authType": "OAUTH2",
	"grantType": "CLIENT_CREDENTIALS",
	"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
	"accessTokenURI": "www.token.com/cred"
}

Create or update notifier with authentication type OAUTH2 and grant type PASSWORD

This is a sample request to create or update a notifier with OAUTH2 and Grant Type PASSWORD.

Sample request

{
	"type": "REST_API",
	"baseURI": "www.google.com",
	"authType": "OAUTH2",
	"grantType": "PASSWORD",
	"userName": "testUser",
	"password": "**********",
	"accessTokenURI": "www.token.com/cred",
	"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
	"apiSecret": "*****************************************"
}

Sample response

{
	"baseURI": "www.google.com",
	"authType": "OAUTH2",
	"grantType": "PASSWORD",
	"userName": "testUser",
	"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
	"accessTokenURI": "www.token.com/cred"
}