W3lcome API
  • Introduction
  • FAQ
  • Authentication
  • Changelog
  • Host
    • The Host Object
    • Retrieve a Host
    • Retrieve a List of Hosts
    • Insert a Host
    • Update a Host
    • Delete a Host
  • Visit
    • The Visit Object
    • Retrieve a Visit
    • Retrieve a List of Visits
    • Change Visit Status
    • Check-out a Visit
    • Check-in with Invitee Id
    • Check-out with Invitee Id
    • Delete a Visit
  • Blocked list
    • The Blocked List Object
    • Retrieve a Person on the Blocked List
    • Retrieve a List of People from the Blocked List
    • Insert a Person on the Blocked List
    • Update a Person on the Blocked List
    • Delete a Person from the Blocked List
  • Invitee
    • The Invitee Object
    • Retrieve an Invitee
    • Retrieve a List of Invitees
    • Insert an Invitee
    • Update an Invitee
    • Delete an Invitee
  • Delivery
    • The Delivery Object
  • Meeting
    • The Meeting Object
  • Notification
    • The Notification Object
  • Webhook
    • Webhook Endpoints
  • Company
    • The Company Object
    • Retrieve Company Information
    • Company Fields
  • Integration
    • W-Access
    • SBT
    • SBT QRCodes
    • Workplace by Facebook
Powered by GitBook
On this page
  • The Object
  • Short Sample
  • Available Methods

Was this helpful?

  1. Delivery

The Delivery Object

The Object

Attribute

Description

*id

stringrequired

It is a unique 32 characters string

*createdAt

stringrequired

Date and time of the visit check-in, e.g.: "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds)

*type string

This is an immutable field which indicates the type of the object. In this case 'delivery'

event

string

pictureUrl string

The URL of the delivery picture

message

string

Optional message dropped by the deliveryman

hosts

array

notes

string

Private notes of the delivery

Short Sample

{
    "id": "6F2A1988-AC8B-458E-A447-4F852A7BB95E",
    "type": "delivery",
    "createdAt": "2019-09-04T11:30:08-03:00",
    "message": "Your pizza",
    "hosts": [
        {
            "type":"host",
            "id":"142e81feb92c0a66ee70fd7f4e57a28d",
            "email":"alisson@w3lcome.com",
            "name":"Alisson Enz Rossi",
            "position":"CTO",
            "sector":"IT",
            "phone":"(43) 99982-0420",
            "countryCode":"+55"
        }
    ]
}

Available Methods

Coming soon

PreviousDelete an InviteeNextThe Meeting Object

Last updated 4 years ago

Was this helpful?

Only used by

An array of

Webhook Endpoint
The Host Object