Flipdish · Schema

WebhookLog

Webhook log

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
WebhookSubscriptionOwnerUserId integer Webhook subscription owner user identifier
EventCreated string Event created
WebhookTriggered string Webhook triggered
WebhookEventName string Webhook event name
WebhookSubscriptionCallbackUrl string Webhook subscription callback url
HttpResponseStatusCode string Received HTTP repsonse status HTTP code
HttpResponseStatus string Received HTTP repsonse status
RequestHeaders string Request headers
RequestBody string Request body
ResponseHeaders string Received response headers
ResponseBody string Received response body
Duration string Duration of HTTP request
RetryCount integer Retry count
FlipdishWebhookId string Flipdish webhook identifier
Version string Flipdish webhook version
View JSON Schema on GitHub

JSON Schema

platform-webhook-log-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/platform-webhook-log-schema.json",
  "title": "WebhookLog",
  "description": "Webhook log",
  "type": "object",
  "properties": {
    "WebhookSubscriptionOwnerUserId": {
      "format": "int32",
      "description": "Webhook subscription owner user identifier",
      "type": "integer",
      "example": 500123
    },
    "EventCreated": {
      "description": "Event created",
      "type": "string",
      "example": "string"
    },
    "WebhookTriggered": {
      "description": "Webhook triggered",
      "type": "string",
      "example": "string"
    },
    "WebhookEventName": {
      "description": "Webhook event name",
      "type": "string",
      "example": "Example Name"
    },
    "WebhookSubscriptionCallbackUrl": {
      "description": "Webhook subscription callback url",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "HttpResponseStatusCode": {
      "description": "Received HTTP repsonse status HTTP code",
      "type": "string",
      "example": "Active"
    },
    "HttpResponseStatus": {
      "description": "Received HTTP repsonse status",
      "type": "string",
      "example": "Active"
    },
    "RequestHeaders": {
      "description": "Request headers",
      "type": "string",
      "example": "string"
    },
    "RequestBody": {
      "description": "Request body",
      "type": "string",
      "example": "string"
    },
    "ResponseHeaders": {
      "description": "Received response headers",
      "type": "string",
      "example": "string"
    },
    "ResponseBody": {
      "description": "Received response body",
      "type": "string",
      "example": "string"
    },
    "Duration": {
      "description": "Duration of HTTP request",
      "type": "string",
      "example": "string"
    },
    "RetryCount": {
      "format": "int32",
      "description": "Retry count",
      "type": "integer",
      "example": 3
    },
    "FlipdishWebhookId": {
      "format": "uuid",
      "description": "Flipdish webhook identifier",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "Version": {
      "description": "Flipdish webhook version",
      "type": "string",
      "example": "string"
    }
  }
}