MOmonato
Webhooks

Update a client webhook

Changed on

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}

Request

Path parameters

clientIdstring uuid required

Client UUID that owns the webhook.

idstring uuid required

Webhook UUID.

Request body

urlstring uri

New delivery URL for the webhook.

tokenstring

New secret used to authenticate webhook delivery.

webhook_status'ACTIVE' | 'INACTIVE'
auth_client_idstring

OAuth client identifier used when auth_type is OAUTH.

auth_client_secretstring

OAuth client secret used when auth_type is OAUTH.

auth_urlstring uri

OAuth token endpoint used for webhook delivery authentication.

auth_scopestring

OAuth scopes requested for webhook delivery authentication.

auth_audiencestring

OAuth audience requested for webhook delivery authentication.

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 uuid required

Webhook configuration UUID.

clientIdstring uuid required

Client UUID that owns the webhook.

urlstring uri required

Destination URL where Monato sends webhook events.

tokenstring

Secret configured for webhook delivery.

webhookType'MONEY_IN' | 'STATUS_UPDATE' | 'CEP' | 'REPORT' | 'REFUND' required
webhookStatus'ACTIVE' | 'INACTIVE' required
createdAtstring date-time

Timestamp when the webhook configuration was created.

updatedAtstring date-time

Timestamp when the webhook configuration was last updated.

deletedAtstring nullable

Timestamp when the webhook configuration was deleted, or null.

blockedAtstring nullable

Timestamp when the webhook configuration was blocked, or null.

deletedBystring nullable

Identifier of the actor that deleted the webhook, or null.

blockedBystring nullable

Identifier of the actor that blocked the webhook, or null.

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"
}

Changes

  • e22ef66945dfRevision changes
    • warning

      added the new ACTIVE enum value to the response property for the response status

    • warning

      added the new CEP enum value to the response property for the response status

    • warning

      added the new INACTIVE enum value to the response property for the response status

    • warning

      added the new MONEY_IN enum value to the response property for the response status

    • warning

      added the new REFUND enum value to the response property for the response status

    • warning

      added the new REPORT enum value to the response property for the response status

    • warning

      added the new STATUS_UPDATE enum value to the response property for the response status

    • info

      api tag Webhooks added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status