v1

latestOpenAPI 3.1.02026-08-06173665.4 KB

Update a client webhook

Updates one or more fields of a webhook owned by the client. All fields in the request body are optional, but at least one must be provided.

patch/v1/clients/{clientId}/webhooks/{id}

Path parameters

clientIdstring uuid required

Client UUID that owns the webhook.

idstring uuid required

Webhook UUID.

Request body

urlstring uri

tokenstring

webhook_status'ACTIVE' | 'INACTIVE'

auth_client_idstring

auth_client_secretstring

auth_urlstring uri

auth_scopestring

auth_audiencestring

Example request

{
  "url": "https://example.com/new-webhook",
  "token": "newTokenValue",
  "webhook_status": "ACTIVE",
  "auth_client_id": "oauth-client-id",
  "auth_client_secret": "oauth-client-secret",
  "auth_url": "https://auth.example.com/oauth2/token",
  "auth_scope": "scope1 scope2",
  "auth_audience": "https://api.example.com"
}

Response

Webhook successfully updated

idstring

clientIdstring

urlstring

tokenstring

webhookTypestring

webhookStatusstring

createdAtstring date-time

updatedAtstring date-time

deletedAtstring nullable

blockedAtstring nullable

deletedBystring nullable

blockedBystring nullable

Example response

{
  "id": "29806117-2b15-4682-87f0-350e6695fe91",
  "clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "url": "https://example.com/webhook",
  "token": "secretToken0123",
  "webhookType": "MONEY_IN",
  "webhookStatus": "ACTIVE",
  "createdAt": "2025-04-03 13:40:54.056794-06:00",
  "updatedAt": "2025-04-03 13:40:54.056794-06:00",
  "deletedAt": "None",
  "blockedAt": "None",
  "deletedBy": "None",
  "blockedBy": "None"
}