Updates a webhook for the given merchant.

put

https://api-sandbox.nofrixion.com/api/v1/webhooks/{id}

Authorization: End user token is required.

User permissions required: CanCreateWebhooks

Path Params

uuid

required

The id of the webhook to update.

Body Params

The WebHookRequest to be updated.

uuid

merchantID

uuid

required

resourceTypes

array of strings | null

The resource types that the webhook should be generated for.

resourceTypes

destinationUrl

string | null

The destination URL for the webhook. Required for webhook notifications.

retry

boolean

secret

string | null

The secret key required to authenticate webhook notifications. Required for webhook notifications.

isActive

boolean

emailAddress

string | null

The recipient email address(es) for notifications. Multiple addresses can be separated by a comma, semicolon, or space. Reruired for email notifications.

failedNotificationEmailAddress

string | null

The email address to which notifications about failed webhook deliveries will be sent.

notificationMethod

string

enum

required

Determines the delivery method for the notification. The default is Webhook.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201

The updated Webhook is returned.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK