Add OAuth

Add an authorized OAuth client to an existing endpoint.

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
endpointId
string

The Id of the endpoint configured for subscription to specified events. Required only for DELETE operations.

Example: ep_2gEymWwsWu5H5EpwbwoOwBnRQBi
Request Body schema: application/json
clientId
string

Customer generated clientId from OAuth server/provider

clientSecret
string

Customer generated client secret from OAuth server/provider

tokenUrl
string <url>

Customer provided https url for obtaining access tokens from the customers OAuth server/provider

extraParams
object

Optional collection of key value pair parameters which may be required depending on OAuth provider.

scope
Array of arrays

Optional array of strings for included scopes if configured by the customer on their OAuth server/provider for the generated client

Responses
204

Successful Request. OAuth Added Successfully.

400

One or more required parameters are missing or invalid.

401

Authentication failed (unauthorized).

403

Forbidden. You do not have permissions to perform this action, or your connection information is not correct.

503

The server is too busy to handle the request.

put/webhooks/endpoint/oauth/{endpointId}
Request samples
application/json
{}