<- Location Custom Attributes webhooks

Location Custom Attributes webhooks

All versions ->

location custom_attribute visible updatedBeta

EVENT

 location.custom_attribute.visible.updated

Published when a location custom attribute that is visible to the subscribing application is created or updated. A notification is sent when:

  • Your application creates or updates a custom attribute owned by your application, regardless of the visibility setting.
  • Any application creates or updates a custom attribute whose visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

Custom attributes set to VISIBILITY_READ_WRITE_VALUES can be created or updated by any application, but those set to VISIBILITY_READ_ONLY or VISIBILITY_HIDDEN can only be created or updated by the owner. Custom attributes are owned by the application that created the corresponding custom attribute definition.

Permissions:MERCHANT_PROFILE_READ
Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the seller associated with the event that triggered the event notification.

Link to section

type

string

The type of this event. The value is "location.custom_attribute.visible.updated".

Link to section

event_id

string

A unique ID for the event notification.

Link to section

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

Link to section

data

The data associated with the event that triggered the event notification.