Single inbound channel that receives every Square webhook event
type subscribed to by the application. The concrete event is
discriminated by the `type` field on the message payload.
A visible merchant custom attribute definition was deleted.
Content-Type: application/json
merchant.custom_attribute.visible.updated
A visible merchant custom attribute value was updated.
Content-Type: application/json
merchant.custom_attribute.visible.deleted
A visible merchant custom attribute value was deleted.
Content-Type: application/json
oauth.authorization.revoked
An OAuth authorization was revoked.
Content-Type: application/json
order.created
An order was created.
Content-Type: application/json
order.fulfillment.updated
An order fulfillment was updated.
Content-Type: application/json
order.updated
An order was updated.
Content-Type: application/json
order.custom_attribute_definition.owned.created
An owned order custom attribute definition was created.
Content-Type: application/json
order.custom_attribute_definition.owned.updated
An owned order custom attribute definition was updated.
Content-Type: application/json
order.custom_attribute_definition.owned.deleted
An owned order custom attribute definition was deleted.
Content-Type: application/json
order.custom_attribute.owned.updated
An owned order custom attribute value was updated.
Content-Type: application/json
order.custom_attribute.owned.deleted
An owned order custom attribute value was deleted.
Content-Type: application/json
order.custom_attribute_definition.visible.created
A visible order custom attribute definition was created.
Content-Type: application/json
order.custom_attribute_definition.visible.updated
A visible order custom attribute definition was updated.
Content-Type: application/json
order.custom_attribute_definition.visible.deleted
A visible order custom attribute definition was deleted.
Content-Type: application/json
order.custom_attribute.visible.updated
A visible order custom attribute value was updated.
Content-Type: application/json
order.custom_attribute.visible.deleted
A visible order custom attribute value was deleted.
Content-Type: application/json
payment.created
A payment was created.
Content-Type: application/json
payment.updated
A payment was updated.
Content-Type: application/json
payout.failed
A payout failed.
Content-Type: application/json
payout.paid
A payout was paid.
Content-Type: application/json
payout.sent
A payout was sent.
Content-Type: application/json
refund.created
A refund was created.
Content-Type: application/json
refund.updated
A refund was updated.
Content-Type: application/json
subscription.created
A subscription was created.
Content-Type: application/json
subscription.updated
A subscription was updated.
Content-Type: application/json
team_member.created
A team member was created.
Content-Type: application/json
team_member.updated
A team member was updated.
Content-Type: application/json
team_member.wage_setting.updated
A team member wage setting was updated.
Content-Type: application/json
job.created
A job was created.
Content-Type: application/json
job.updated
A job was updated.
Content-Type: application/json
terminal.checkout.created
A Terminal checkout was created.
Content-Type: application/json
terminal.checkout.updated
A Terminal checkout was updated.
Content-Type: application/json
terminal.refund.created
A Terminal refund was created.
Content-Type: application/json
terminal.refund.updated
A Terminal refund was updated.
Content-Type: application/json
terminal.action.created
A Terminal action was created.
Content-Type: application/json
terminal.action.updated
A Terminal action was updated.
Content-Type: application/json
transfer_order.created
A transfer order was created.
Content-Type: application/json
transfer_order.updated
A transfer order was updated.
Content-Type: application/json
transfer_order.deleted
A transfer order was deleted.
Content-Type: application/json
vendor.created
A vendor was created.
Content-Type: application/json
vendor.updated
A vendor was updated.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.