WebhookRoute
Model
A model for creating/updating webhook routes
Required
providerType :
WebhookRouteProviderTypes
The type of provider the ProviderID references
Required
providerID :
number (int)
The int ID of the provider from the appropriate Providers enum (eg GeneralProviders)
Required
MaxLength(16)
organisationCode :
string
The POS organisation's OrgCode to route the webhook message to
Required
outletID :
string (GUID)
The POS organisation's OutletID to route the webhook message to
Required
MaxLength(128)
providerOutletID :
string
The provider's outlet identifier used for mapping incoming webhooks to a specific outlet id in POS
Required
enabled :
bool
Is the webhook enabled for routing to POS?
Nullable
MaxLength(256)
webhookSecret :
string
The optional webhook secret used to validate webhook notifications (where applicable)
Example
{
"providerType": 1,
"providerID": 321,
"organisationCode": "string value",
"outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"providerOutletID": "string value",
"enabled": true,
"webhookSecret": "string value"
}