invantive documentation
Invantive Support ForumsLog In / Sign Up

WebhookById: Minox Webhook by ID

read only per partition REST

  • Catalog: Minox
  • Schema: ThirdPartyWebhook
  • Label: Webhook by ID

Retrieves information about a webhook.

The data in this table is partitioned per value of the administration_code column.

Can only retrieve data.

API Source

  • Endpoint: /tenant/{tenant_id}/webhook/{webhook_id}
  • Operation: get /tenant/{tenant_id}/webhook/{webhook_id}

Parameters

Name Data Type Required Default Documentation
administration_code `` Partition to retrieve data from.
webhook_id `` (uuid) The identity of the webhook.

Table Columns

The columns of the table WebhookById are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
authenticationType varchar2 Authentication Type filters on the platform, writable, authenticationType Determines if the webhook uses basic authentication or bearer
bearer varchar2 Bearer filters on the platform, writable, bearer When the authenticationType 'bearer' is chosen, this value is used.
description varchar2 Description filters on the platform, writable, description Descriptive text about the webhook
enabled char Enabled filters on the platform, writable, enabled
id guid ID filters on the platform, writable, id
notification_on_400 varchar2 Notification On 400 filters on the platform, writable, notification_on_400 When set, Minox will sent an email to the specified address when delivery of the webhook fails with a HTTP error in the 400 range.
notification_on_500 varchar2 Notification On 500 filters on the platform, writable, notification_on_500 When set, Minox will sent an email to the specified address when delivery of the webhook fails with a HTTP error in the 500 range.
notifications_payable char Notifications Payable filters on the platform, writable, notifications.payable
notifications_receivable char Notifications Receivable filters on the platform, writable, notifications.receivable
password varchar2 Password filters on the platform, writable, password When the authenticationType 'basic' is chosen, this value is used for the password.
retry_in_minutes decimal Retry In Minutes filters on the platform, writable, retry_in_minutes The number of minutes between retry attempts. There is a maximum of 14 attempts in total.
url varchar2 URL filters on the platform, writable, url
username varchar2 Username filters on the platform, writable, username When the authenticationType 'basic' is chosen, this value is used for the username.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

Changes of This Table, 26.0 to 27.0

  • - administration_code
  • - administration_name

All changes of the driver, 26.0 to 27.0