Sign in
Webhooks

Updates a webhook for the given merchant.

<b>Authorization</b>: End user token is required.

<b>User permissions required</b>: CanCreateWebhooks

put/api/v1/webhooks/{id}

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/webhooks/{id}
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

The id of the webhook to update.

Request body

idstring uuid
merchantIDstring uuid required
resourceTypesstring[] nullable

The resource types that the webhook should be generated for.

destinationUrlstring nullable

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

retryboolean
secretstring nullable

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

isActiveboolean
emailAddressstring email nullable

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

failedNotificationEmailAddressstring email nullable

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

notificationMethod'None' | 'Webhook' | 'Email' required

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

Response

OK

idstring uuid
resourceTypesstring[] nullable

The resource types that the webhook will be generated for.

destinationUrlstring nullable
retryboolean
secretstring nullable
isActiveboolean
emailAddressstring nullable
versioninteger
failedNotificationEmailAddressstring nullable

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

merchantIDstring uuid

The ID of the merchant that the webhook is for.

notificationMethod'None' | 'Webhook' | 'Email'

The type of notification that will be sent.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.