v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Webhooks Integration

Update an OAuth2 client credentials auth method

Update an existing OAuth2 client credentials auth method.

patch/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}

Path parameters

auth_method_idstring required

The UUID of the auth method.

Request body

Example request

{
  "data": {
    "attributes": {
      "access_token_url": "https://example.com/oauth/token",
      "audience": "https://api.example.com",
      "client_id": "my-client-id",
      "client_secret": "my-client-secret",
      "name": "my-oauth2-auth",
      "scope": "read:webhooks write:webhooks"
    },
    "type": "webhooks-auth-method-oauth2-client-credentials"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "access_token_url": "https://example.com/oauth/token",
      "audience": "https://api.example.com",
      "client_id": "my-client-id",
      "name": "my-oauth2-auth",
      "protocol": "oauth2-client-credentials",
      "scope": "read:webhooks write:webhooks"
    },
    "id": "596da4af-0563-4097-90ff-07230c3f9db3",
    "type": "webhooks-auth-method-oauth2-client-credentials"
  }
}