...
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Accept
|
| ||||||||||
Authorization
| Base 64 encoded string containing the |
Response
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Triggers
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
All triggers use same endpoint for subscribe and unsubscribe. |
Subscribe
Request
Status | ||||
---|---|---|---|---|
|
...
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
url
| Zapier webhook url stored in | ||||||||||
method
|
| ||||||||||
alias
| Alias for the trigger in Thiio, the value should be like this | ||||||||||
event
| Event for trigger in Thiio, posible values:
|
Response
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{ "userdata": { "id": 1, "uuidid": "32ce1a5a716fcaa4-8e9c4554-4a20449a-afffaa85-57c1deaee136cc75f24ebb77", "contact_id": 1, "typemetadata": "customer_employee", { "email": "admin@thiio.com", "email_verified_atalias": null,"Zapier - Transaction "password": "$2y$10$hg98Bo7a9QFwZPGOf.xRe.9ZXfgb9N2NHfeW9vDHQiQr37gC.MOY2"declined", "metadata": { "languagemethod": "enzapier", "dashboards": { "default": "set_up "url": "https:\/\/hooks.zapier.com\/hooks\/standard\/19665925\/e47c7eefa5ed47d59379c29158b96c67\/", "event": "transaction-declined" } }, "message": "Integration Channel created" } |
Unsubscribe
Request
Status | ||||
---|---|---|---|---|
|
Header parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Accept
|
| ||||||||||
Authorization
| Base 64 encoded string containing the |
Path parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id
| Zapier subscribe id stored in |
Response
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{
"message": "Integration Channel deleted",
"data": null
} |
Perform list
Request
Status | ||||
---|---|---|---|---|
|
Header parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Accept
|
| ||||||||||
Authorization
| Base 64 encoded string containing the |
Path parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
list
| Posible values
|
Response for customers
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{
"first_name": "krista",
"last_name": "durgan",
"email": "durganfb5a8jf3@gmail.com",
"id": 1,
"url": "http://koelpin.net/temporibus-sit-et-et-incidunt",
"type": "customer",
"date": "2024-08-12",
"customer_since": "2024-08-12T22:31:00Z",
"lifetime_value": 0,
"activations_count": 0
} |
Response for orders
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Response for shippings
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Response for subscriptions
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Response for surveys
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{
"title": "Survey recusandae sint tempora voluptatibus modi",
"description": "Laudantium repudiandae est ea corporis.",
"take": "once",
"capture_name": true,
"capture_phone": true,
"capture_at_end": true,
"status": true,
"start_question_id": null,
"lead_capture": "at_end",
"metadata": {
"end": {
"x_position": 890,
"y_position": 100
},
"start": {
"x_position": 100,
"y_position": 100
}
}
} |
Response for transactions
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Response for transaction-histories
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Actions
Create lead with customer note
Request
Status | ||||
---|---|---|---|---|
|
Header parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Accept
|
| ||||||||||
Authorization
| Base 64 encoded string containing the |
Body parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
event |
| ||||||||||
source |
| ||||||||||
contact
| The contact object | ||||||||||
contact.email
| The customer email E.g. customer@thiio.com | ||||||||||
contact.first_name
| The customer first name E.g. John | ||||||||||
contact.last_name
| The customer last_name E.g. Doe | ||||||||||
phone
| The phone object | ||||||||||
phone.country
| The customer phone country code E.g. US | ||||||||||
phone.number
| The customer phone number E.g. +17723611127 |
Response
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{
"event": "customer",
"source": "zapier",
"contact": {
"email": "customer@thiio.com",
"last_name": "Doe",
"first_name": "John"
},
"phone": {
"country": "US",
"number": "+17723611127"
}
} |
Create shipping tracking info update
Request
Status | ||||
---|---|---|---|---|
|
Header parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Accept
|
| ||||||||||
Authorization
| Base 64 encoded string containing the |
Path parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
shipping_uuid
| The uuid of the shipping to update. |
Body parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
carrier
| Carrier of the shipping E.g. dhl | ||||||||||
tracking_number
| Tracking number of shipping E.g. 123 |
Response
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{
"id": "7862121f-b903-43bf-ae31-d77ecd585f12",
"carrier": "dhl",
"tracking_number": "123",
"tracking_url": null,
"external_id": null,
"created_at": "2024-07-30 12:12:16",
"order_id": "cd500928-4f8d-415a-bf57-07f8cd73c86d",
"order": {
"id": "cd500928-4f8d-415a-bf57-07f8cd73c86d",
"number": 114,
"type": null,
"source": "admin",
"env": "test",
"receipt_sent_at": "2024-07-30 11:50:44",
"is_shippable": true,
"subtotal_pre_tax": 675,
"shipping_pre_tax": 27,
"subtotal": 675,
"discount": 0,
"shipping": 27,
"taxes": 0,
"total": 702,
"metadata": null,
"recurrent": false,
"payment_method": null,
"coupon": null,
"created_at": "2024-07-30 11:50",
"shipping_overwritten": false,
"lucas_call_sid": null
}
} |
Create subscription cancelation
Request
Status | ||||
---|---|---|---|---|
|
Header parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Accept
|
| ||||||||||
Authorization
| Base 64 encoded string containing the |
Path parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
subscription_uuid
| The uuid of the subscription to cancel. |
Response
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{
"id": "e7df6809-2917-4cd6-b368-2bb8080a3b8c",
"env": "test",
"coupon": null,
"plan": {
"id": "02f8c19b-527b-4100-9586-b6b399913724",
"name": "Plan for Product Physical with Variations and Plans ",
"period": "biweekly",
"quantity": 1,
"trial_days": 0,
"type": "service_drip"
},
"product_variation_plan": {
"id": "3c305af7-e10e-4868-8846-939151e7f59c",
"unit_price": 571,
"shipping_price": 14,
"amount": 585
},
"current_plan_intervals": 1,
"product": {
"id": "ed2ba3c2-18fd-431b-8619-881c3c981901",
"name": "Product Physical with Variations and Plans ",
"type": "physical",
"has_variations": true,
"main_image": {
"conversions": {
"sm": "https://webassets.dev/img/products/physical.svg"
},
"url": "https://webassets.dev/img/products/physical.svg"
}
},
"product_variation": {
"id": "e357e7c5-4e01-40f8-92f5-89872e4c41f5",
"name": "Color RED",
"sku": "80mWJdRse3d",
"main_image": null
},
"status": "canceled",
"amount": 585,
"on_grace_period": false,
"period_started_at": "2024-07-30 00:00:00",
"accessible_until": "2024-08-15 23:59:59",
"next_payment_date": null,
"created_at": "2024-07-30 14:26:46",
"updated_at": "2024-07-30 14:39:02",
"metadata": null
} |
Create lead with order note
Request
Status | ||||
---|---|---|---|---|
|
Header parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Accept
|
| ||||||||||
Authorization
| Base 64 encoded string containing the |
Body parameters
Parameter | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
event |
| ||||||||||
source |
| ||||||||||
contact
| The contact object | ||||||||||
contact.email
| The customer email E.g. john.doe@thiio.com | ||||||||||
contact.first_name
| The customer first name E.g. John | ||||||||||
contact.last_name
| The customer last_name E.g. Doe | ||||||||||
phone
| The phone object | ||||||||||
phone.country
| The customer phone country code E.g. US | ||||||||||
phone.number
| The customer phone number E.g. +15124713434 | ||||||||||
billing_address
| The billing address object | ||||||||||
billing_address.first_name
| The billing address first name E.g. John | ||||||||||
billing_address.last_name
| The billing address last_name E.g. Doe | ||||||||||
billing_address.line1
| The billing address line 1 E.g. 11801 Stonehollow Drive | ||||||||||
billing_address.line2
| The billing address line 2 E.g. Line 2 | ||||||||||
billing_address.city
| The billing address city E.g. Austin | ||||||||||
billing_address.state
| The billing address state E.g. TX | ||||||||||
billing_address.zip_code
| The billing address zip code E.g. 78758 | ||||||||||
billing_address.country
| The billing address country E.g. US | ||||||||||
shipping_address
| The shipping address object | ||||||||||
shipping_address.first_name
| The shipping address first name E.g. John | ||||||||||
shipping_address.last_name
| The shipping address last_name E.g. Doe | ||||||||||
shipping_address.line1
| The shipping address line 1 E.g. 11801 Stonehollow Drive | ||||||||||
shipping_address.line2
| The shipping address line 2 E.g. Line 2 | ||||||||||
shipping_address.city
| The shipping address city E.g. Austin | ||||||||||
shipping_address.state
| The shipping address state E.g. TX | ||||||||||
shipping_address.zip_code
| The shipping address zip code E.g. 78758 | ||||||||||
shipping_address.country
| The shipping address country E.g. US | ||||||||||
order
| The order object | ||||||||||
order.id
| The order id E.g. 123 | ||||||||||
order.type
| The order type E.g. Doe | ||||||||||
order.user_id
| The order user id E.g. 10 | ||||||||||
order.date
| The order date E.g. 2024-08-14 | ||||||||||
order.shipping
| The order shipping E.g. 10 | ||||||||||
order.taxes
| The order taxes E.g. 10 | ||||||||||
order.total
| The order total E.g. 120 | ||||||||||
order.items
| The order items object | ||||||||||
order.items.name
| The order item name E.g. Product 1 | ||||||||||
order.items.title
| The order item title E.g. Product 1 red | ||||||||||
order.items.quantity
| The order item quantity E.g. 1 | ||||||||||
order.items.price
| The order item price E.g. 50 |
Response
Status | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
{ "success": true, "msg": "received successfully", "err": "", "data": { "event": "order", "source": "zapier", "contact": { "first_name": "John", "last_name": "Doe", "email": "john.doe@thiio.com" }, "phone": { "country": "US", "number": "+15124713434" }, "billing_address": { "first_name": "John", "last_name": "Doe", "line1": "11801 Stonehollow Drive", "line2": "line two", "city": "Austin", "state": "TX", "zip_code": "78758", "country": "US" }, "shipping_address": { "first_name": "John", "last_name": "Doe", "line1": "11801 Stonehollow Drive", "line2": "line two", "city": "Austin", "state": "TX", "zip_code": "78758", "favoritescountry": [ "US" }, "order": { "set_up"id": 123, "default""type": "success", "user_id": 10, ] }"date": "2024-08-14", "date_formatshipping": "DD/MM/YYYY"10, "workspace_typetaxes": "advanced"10, "test_token_timetotal": 30120, "worker_attributesitems": {[ { "lucas_uri": "agent_1_admin", "contact_uriname": "client:1_adminProduct one", "inbound_callstitle": 0,"Product one Red", "inbound_conversationsquantity": 01, } },"price": 50 "integrations_meta": null, }, "dialer_extension": null, "dialer_worker_sid": "WK4a1887b78f41363a21d5e03f3171a873", { "dialer_activity_sid": "WA993d72c19cd2b35bfc6e2cc9b2690348", "dialer_activity_name": "IdleProduct two", "remember_token": null, "welcome_email_senttitle": 0"Product two White", "two_factor_enabled": 0, "two_factor_secret_keyquantity": null1, "deactivated_at": null, "created_atprice": "2024-06-21 00:23:02", 50 "updated_at": "2024-06-24 12:33:14", } "deleted_at": null, ] "uri": "client:1_admin" } } } |