PUT

Upsert webhook OAuth config

Creates or updates the OAuth 2.0 client credentials configuration for a webhook. The client secret is encrypted at rest using KMS when the oauth-kms-enabled feature flag is active.

Path Params

webhookId string required

The unique identifier of the webhook to configure OAuth for

Body Params

object

tokenUrl string required

at least 1 characters
clientId string required

at least 1 characters
clientSecret string required

at least 1 characters
scope string required

at least 1 characters

Responses

200

OAuth config upserted successfully

Response Body

object

webhookId string required
tokenUrl string required
clientId string required
scope string required
createdAt string date-time required
updatedAt string date-time required

400

Invalid request parameters

Response Body

object

Bad request error response

name string enum required

Error code

ValidationFailedIllegalArgumentBadRequestDataIntegrityErrorNotImplementedErrorRETRIGGER_RATE_LIMITEDUSER_CREATION_FAILEDUSER_FALLBACK_FAILED
error string required

Human-readable error message
status integer enum int32 required

HTTP status code

400

403

Access denied

Response Body

object

Forbidden error response

name string enum required

Error code

AccessDenied
error string required

Human-readable error message
status integer enum int32 required

HTTP status code

403

500

Unexpected error occurred

Response Body

object

Internal server error response

name string enum required

Error code

UnexpectedErrorThirdPartyErrorDatabaseErrorUSER_FALLBACK_TIMEOUT
error string required

Human-readable error message
status integer enum int32 required

HTTP status code

500

curl --request PUT \ --url 'https://app.bitgo-test.com/api/notifications/v1/webhooks/webhookId/oauth-config' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"tokenUrl":"string","clientId":"string","clientSecret":"string","scope":"string"}'

const url = 'https://app.bitgo-test.com/api/notifications/v1/webhooks/webhookId/oauth-config'; const options = { method: 'PUT', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"tokenUrl":"string","clientId":"string","clientSecret":"string","scope":"string"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/notifications/v1/webhooks/webhookId/oauth-config") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"tokenUrl":"string","clientId":"string","clientSecret":"string","scope":"string"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('PUT', 'https://app.bitgo-test.com/api/notifications/v1/webhooks/webhookId/oauth-config', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"tokenUrl":"string","clientId":"string","clientSecret":"string","scope":"string"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/notifications/v1/webhooks/webhookId/oauth-config" payload = {,"tokenUrl":"string","clientId":"string","clientSecret":"string","scope":"string"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.text)