Qorus Integration Engine® Enterprise Edition 7.1.0_prod
Loading...
Searching...
No Matches
OMQ::QorusWebhookInfo hashdecl Reference

Webhook info. More...

Public Attributes

string name
 The name of the webhook.
 
string rest_method = "POST"
 The name of the REST method; may be "POST", "PUT", "GET".
 
int auth = QAUTH_QORUS
 Specifies authentication for the webhook.
 
*list< string > perms
 Any permissions required when auth is QAUTH_QORUS.
 
*string event_loc
 The location of the data in dot notation.
 
*string echo_header
 Any header in webhook requests to echo in responses.
 
*softlist< string > echo_body_keys
 Any keys in webhook request bodies to echo in responses.
 
*string confirmation_key_loc
 The location of the value that determines if the message is a confirmation message.
 
*string confirmation_value
 The value in confirmation_key_loc that determines if the message is a confirmation message.
 
*string confirmation_url_loc
 The location of the confirmation URL in the confirmation message in dot notation.
 
string confirmation_method = "GET"
 The HTTP method to use when calling the confirmation URL.
 
*string assume_json
 Assume JSON for the following content type.
 

Detailed Description

Webhook info.

Member Data Documentation

◆ auth

int OMQ::QorusWebhookInfo::auth = QAUTH_QORUS

Specifies authentication for the webhook.

Note
The LOGIN permission is always required when auth is QAUTH_QORUS

◆ name

string OMQ::QorusWebhookInfo::name

The name of the webhook.

This value is generated automatically when the webhook is created; any value provided here when creating webhooks is ignored

Note
May only contain characters A-Za-z0-9-_

◆ perms

*list<string> OMQ::QorusWebhookInfo::perms

Any permissions required when auth is QAUTH_QORUS.

This value is only used when auth is QAUTH_QORUS

Note
LOGIN is always required when auth is QAUTH_QORUS, so it never has to be listed here

The documentation for this hashdecl was generated from the following file: