Update a webhook

patch /companies/{companyId}/webhooks/{webhookId}

Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.

To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write

Endpoint destination URL

Click to copy

Path parameters

webhookId string Required

Unique identifier of the webhook configuration.

companyId string Required

The unique identifier of the company account.

Request parameters

acceptsExpiredCertificate boolean

Indicates if expired SSL certificates are accepted. Default value: false.

acceptsSelfSignedCertificate boolean

Indicates if self-signed SSL certificates are accepted. Default value: false.

acceptsUntrustedRootCertificate boolean

Indicates if untrusted SSL certificates are accepted. Default value: false.

active boolean

Indicates if the webhook configuration is active. The field must be true for us to send webhooks about events related an account.

additionalSettings object

Additional shopper and transaction information to be included in your standard notifications. Find out more about the available additional settings.

communicationFormat string

Format or protocol for receiving webhooks. Possible values:

  • soap
  • http
  • json
description string

Your description for this webhook configuration.

filterMerchantAccountType string

Shows how merchant accounts are filtered when configuring the webhook. Possible values:

  • includeAccounts: The webhook is configured for the merchant accounts listed in filterMerchantAccounts.
  • excludeAccounts: The webhook is not configured for the merchant accounts listed in filterMerchantAccounts.
  • allAccounts: Includes all merchant accounts, and does not require specifying filterMerchantAccounts.
filterMerchantAccounts array [string]

A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for filterMerchantAccountType.

Required if filterMerchantAccountType is either:

  • includeAccounts
  • excludeAccounts

Not needed for filterMerchantAccountType: allAccounts.

networkType string

Network type for Terminal API notification webhooks. Possible values:

  • public
  • local

Default Value: public.

password string

Password to access the webhook URL.

populateSoapActionHeader boolean

Indicates if the SOAP action header needs to be populated. Default value: false.

Only applies if communicationFormat: soap.

sslVersion string

SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

If not specified, the webhook will use sslVersion: TLSv1.2.

url string

Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.

username string
Max length: 255

Username to access the webhook URL.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy