order custom_attribute_definition visible updatedBeta

EVENT

order.custom_attribute_definition.visible.updated

Published when an order custom attribute definition that is visible to the subscribing app is updated.

Permissions:ORDERS_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the target seller associated with the event.

Link to section

type

string

The type of this event. The value is "order.custom_attribute_definition.visible.updated".

Link to section

event_id

string

A unique ID for the event.

Link to section

created_at

string

Read only The timestamp of when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

The data associated with the event.

Show attributes

Link to section

Examples

Response JSON

{
  "merchant_id": "MLABZFS5JTW5B",
  "type": "order.custom_attribute_definition.visible.updated",
  "event_id": "b0262c17-dea7-3a7e-aeb2-52bfb962959b",
  "created_at": "2022-11-09T21:25:45.592Z",
  "data": {
    "type": "custom_attribute_definition",
    "id": "sq0ids-tr5sCkWm3b9X9MkpAvJ42A:table-number",
    "object": {
      "created_at": "2022-11-09T21:25:28.693Z",
      "description": "Table number at a location",
      "key": "sq0ids-tr5sCkWm3b9X9MkpAvJ42A:table-number",
      "name": "Table Number",
      "schema": {
        "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
      },
      "updated_at": "2022-11-09T21:25:45.592Z",
      "version": 2,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  }
}