Synctera · Schema

Webhook event

Webhook event object

FinTechBaaSBankingPaymentsCard IssuingKYC

Properties

Name	Type	Description
event_resource	string	Json string of object associated with the event. For example, if your event is ACCOUNT.CREATED, You can refer to Acccount to parse the account event to obtain the ID, status etc.
event_resource_changed_fields	string	Json string of object associated with the event related to a resource change. This only contains those fields that have value changed on the event, and the field values are prior to the resource chang
event_time	string	Timestamp of the current event raised
id	string	Unique event ID of the webhook request. Use event endpoints to get more event summary data
metadata	string	Metadata that stored in the webhook subscription
response_history	array	Response history of the webhook request
status	string	Current event status. Failing event will keep retry until it is purged.
type	object
url	string	URL that the current event will be sent to
webhook_id	string	Webhook the current event belongs to

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/event",
  "title": "Webhook event",
  "description": "Webhook event object",
  "properties": {
    "event_resource": {
      "description": "Json string of object associated with the event. For example, if your event is ACCOUNT.CREATED, You can refer to Acccount to parse the account event to obtain the ID, status etc.\n",
      "type": "string"
    },
    "event_resource_changed_fields": {
      "description": "Json string of object associated with the event related to a resource change. This only contains those fields that have value changed on the event, and the field values are prior to the resource change event.\n",
      "type": "string"
    },
    "event_time": {
      "description": "Timestamp of the current event raised",
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "description": "Unique event ID of the webhook request. Use event endpoints to get more event summary data",
      "format": "uuid",
      "readOnly": true,
      "type": "string"
    },
    "metadata": {
      "description": "Metadata that stored in the webhook subscription",
      "maxLength": 1024,
      "type": "string"
    },
    "response_history": {
      "description": "Response history of the webhook request",
      "items": {
        "$ref": "#/components/schemas/response_history_item"
      },
      "type": "array"
    },
    "status": {
      "description": "Current event status. Failing event will keep retry until it is purged.",
      "enum": [
        "RUNNING",
        "SUCCESS",
        "RETRYING"
      ],
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/event_type_explicit"
    },
    "url": {
      "description": "URL that the current event will be sent to",
      "maxLength": 1024,
      "type": "string"
    },
    "webhook_id": {
      "description": "Webhook the current event belongs to",
      "format": "uuid",
      "type": "string"
    }
  },
  "type": "object"
}