All Versions

Customer created

EVENT customer.created

Published when a customer is created. Subscribe to this event to track customer profiles affected by a merge operation. For more information, see Use Customer Webhooks.

The customer object in the event notification does not include the following fields: cards (deprecated) and segment_ids.

Permissions

CUSTOMERS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the seller associated with the event.
`type string`	The type of event. For this object, the value is `customer.created`.
`event_id string`	The unique ID of the event, which is used for idempotency support.
`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
`data CustomerCreatedSquareEventData`	The data associated with the event.

Examples

All Versions

{
  "merchant_id": "G7MMEBVW021Q4",
  "type": "customer.created",
  "event_id": "e12b5591-e0b6-4967-810a-307c7efcb1a7",
  "created_at": "2022-11-09T21:23:25Z",
  "data": {
    "type": "customer",
    "id": "QPTXM8PQNX3Q726ZYHPMNP46XC",
    "object": {
      "customer": {
        "address": {
          "address_line_1": "1018 40th Street",
          "administrative_district_level_1": "CA",
          "locality": "Oakland",
          "postal_code": "94608"
        },
        "birthday": "1962-03-04",
        "created_at": "2022-11-09T21:23:25.519Z",
        "creation_source": "DIRECTORY",
        "email_address": "[email protected]",
        "family_name": "Smorly",
        "given_name": "Jenkins",
        "group_ids": [
          "JGJCW9S0G68NE.APPOINTMENTS"
        ],
        "id": "QPTXM8PQNX3Q726ZYHPMNP46XC",
        "phone_number": "+12126668929",
        "preferences": {
          "email_unsubscribed": false
        },
        "updated_at": "2022-11-09T21:23:25Z",
        "version": 0
      }
    }
  }
}