All Versions

Customer custom attribute definition visible created

EVENT customer.custom_attribute_definition.visible.created

Published when a customer custom attribute definition that is visible to the subscribing application is created. A notification is sent when your application creates a custom attribute definition or another application creates a custom attribute definition whose visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

Permissions

CUSTOMERS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the seller associated with the event that triggered the event notification.
`type string`	The type of this event. The value is `"customer.custom_attribute_definition.visible.created"`.
`event_id string`	A unique ID for the event notification.
`created_at string`	Read only The timestamp that indicates when the event notification 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
`data CustomAttributeDefinitionSquareEventData`	The data associated with the event that triggered the event notification.

Examples

All Versions

{
  "merchant_id": "DM7VKY8Q63GNP",
  "type": "customer.custom_attribute_definition.visible.created",
  "event_id": "f679dc4f-3619-4764-a4de-94a54735cd32",
  "created_at": "2022-04-21T21:40:49.943Z",
  "data": {
    "type": "custom_attribute_definition",
    "id": "sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size",
    "object": {
      "created_at": "2022-04-21T21:40:49Z",
      "description": "The customer's shirt size",
      "key": "sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size",
      "name": "Shirt Size",
      "schema": {
        "type": "array",
        "items": {
          "names": [
            "Small",
            "Medium",
            "Large"
          ],
          "enum": [
            "9492bdda-ab4d-4eeb-8496-0986c8f78499",
            "6b96fba7-d8a5-ae72-48f4-8c3ee875633f",
            "4032c1a2-d749-4c75-9c30-be6472cd2e08"
          ]
        },
        "maxItems": 1,
        "uniqueItems": true
      },
      "updated_at": "2022-04-21T21:40:49Z",
      "version": 1,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  }
}