FAfatzebra

Update a webhook

Changed on

Update a webhook

put/web_hooks/{id}

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/web_hooks/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Id of the webhook

Request body

namestring

The mode for the web hook. Possible values are: Test or Production

modestring

The mode for the web hook. Possible values are: Test or Production

addressstring

The URL for the web hook to target. This must start with http:// or https://

authentication_usernamestring

The username for HTTP Basic authentication

authentication_passwordstring

The password for HTTP Basic authentication (optional)

eventsstring

A list of events for the web hook to target. This is a comma separated list of events, and it is possible to use wildcards (e.g. * for all events, or direct_entry:* for all direct entry hooks, or direct_entry:created,direct_entry:failed)

Response

200

successfulboolean
testboolean

Example response

{
  "successful": true,
  "response": {
    "address": "https://www.your-server.com/payment/hook",
    "events": "*",
    "mode": "Test",
    "name": "Test Hook Updated",
    "id": "071-WH-ABCD1234"
  },
  "test": true
}

Changes