Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 10 Next »

Authentication

Zapier authentication.

Login

Zapier login.

Request

POST /api/login

Header parameters

Parameter

Value

Accept

STRING REQUIRED

application/json

Body parameters

Parameter

Value

email

STRING REQUIRED

The email of the user

E.g. admin@thiio.com

password

STRING REQUIRED

The password for the email

E.g. 123456789

integration

STRING REQUIRED

zapier

Response

  OK

200 

{
  "data": {
    "user": {
      ...
    },
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiNDUxMzA2YTkzZDYzY2Q3MTdhNTdmNTNkYjY3MDkxNDgzZDNjMzEyYmMyMTEyMGM5M2IyYWM3ZjJhODkyNjAzOTE1NDBlYzVmMmIxZGFlYWQiLCJpYXQiOjE3MjM1NzkzODAuNzYxNzc2LCJuYmYiOjE3MjM1NzkzODAuNzYxNzgxLCJleHAiOjE4ODEzNDU3ODAuNzM1MzQzLCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.d4fwmsSomnRsDv7l1Ly86D8hlpz2RHPbq37bOuj7Qf_ngoVw3ffe_vbuqI0nQ0tqD6fy5Cqdcycevk3mr52SpcY0hiuDwBHW50w1qSbheKGIYtQOLqA7pNzaAWa5UWFTRQmja1FxZpGq_Iwp3IPztHgM_zTcSGgsclrbn7NT69sGw04hbGxkr2p_q5vMjUyUaC0XSLq5cIcKNPTnna_oVJdN4_gf4G6Q4lNfij5FdE5FZSohnX2r5IrfSgoZdX42jJIsT6SI1vcIrDkqvNDU1XWcE2H1epRQJtcm9a7zvuxWMaQdJIw3Ih7UNe7FRewtxCsQUSgALRkyuZLnhhhKgFtcS-Vx0dY6Mk3sijvpeW4ruYTxuyI85g5E4MFwlQcbYpHLLzWSCLLQqtaiqTXuR94cWyIv0Eyz1td3bLa-26ki9d-zChzkMtze-oO48dPshw1zEIpWeUuE1MnwQ7cqgDLreKtcwKsGxNh5ZcuA0OW7I2Ai6kgMDOX7MNG9DFuOU7YI1qi3KvZtSFxd1C6BRXHzcDIHeJcT_-FC996kg46kNeVW5F7U-bpAFdKoXDPw5sP93KmDv7KVoOCxWjHDLKtlw_l2KnYwLvf4dyiQOxqB0m8SVZUF9dTdRfPgwfIfLAS5iBFzmCNzclk-wKVXiuFULykDAlk4t3Vg9xYFEa8",
    "expires": 1881345780,
    "setup_finished": true,
    "integration_uuid": "92e1234af-d123-4ece-b222-54a1437x4831a"
  }
}

Check user logged in

Zapier check user logged.

Request

GET /api/check

Header parameters

Parameter

Value

Accept

STRING REQUIRED

application/json

Authorization

STRING REQUIRED

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Response

200 OK

{
  "user": {
    "id": 1,
    "uuid": "32ce1a5a-8e9c-4a20-afff-57c1deaee136",
    "contact_id": 1,
    "type": "customer_employee",
    "email": "admin@thiio.com",
    "email_verified_at": null,
    "password": "$2y$10$hg98Bo7a9QFwZPGOf.xRe.9ZXfgb9N2NHfeW9vDHQiQr37gC.MOY2",
    "metadata": {
      "language": "en",
      "dashboards": {
        "default": "set_up",
        "favorites": [
          "set_up",
          "default"
        ]
      },
      "date_format": "DD/MM/YYYY",
      "workspace_type": "advanced",
      "test_token_time": 30,
      "worker_attributes": {
        "lucas_uri": "agent_1_admin",
        "contact_uri": "client:1_admin",
        "inbound_calls": 0,
        "inbound_conversations": 0
      }
    },
    "integrations_meta": null,
    "dialer_extension": null,
    "dialer_worker_sid": "WK4a1887b78f41363a21d5e03f3171a873",
    "dialer_activity_sid": "WA993d72c19cd2b35bfc6e2cc9b2690348",
    "dialer_activity_name": "Idle",
    "remember_token": null,
    "welcome_email_sent": 0,
    "two_factor_enabled": 0,
    "two_factor_secret_key": null,
    "deactivated_at": null,
    "created_at": "2024-06-21 00:23:02",
    "updated_at": "2024-06-24 12:33:14",
    "deleted_at": null,
    "uri": "client:1_admin"
  }
}

Triggers

All triggers use same endpoint for subscribe and unsubscribe.

Subscribe

Request

POST /api/integrations/{integration_uuid}/channels

Header parameters

Parameter

Value

Accept

STRING REQUIRED

application/json

Authorization

STRING REQUIRED

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Path parameters

Parameter

Value

integration_uuid

STRING REQUIRED

The uuid of integration for system notifications, this value is sent by the Login endpoint.

Body parameters

Parameter

Value

url

STRING REQUIRED

Zapier webhook url stored in {{bundle.targetUrl}}

method

STRING REQUIRED

zapier

alias

STRING REQUIRED

Alias for the trigger in Thiio, the value should be like this Zapier - <name of trigger> (e.g. Zapier - Order completed)

event

STRING REQUIRED

Event for trigger in Thiio, posible values:

  • contact-created

  • order-completed

  • refund-applied

  • subscription-canceled

  • transaction-declined

  • customer-created

  • shipping-tracking-info-updated

  • product-conflicts

  • approved-transaction

  • survey-completed

Response

200 OK

{
    "data": {
        "id": "716fcaa4-4554-449a-aa85-cc75f24ebb77",
        "metadata": {
            "alias": "Zapier - Transaction declined",
            "method": "zapier",
            "url": "https:\/\/hooks.zapier.com\/hooks\/standard\/19665925\/e47c7eefa5ed47d59379c29158b96c67\/",
            "event": "transaction-declined"
        }
    },
    "message": "Integration Channel created"
}

Unsubscribe

Request

DELETE /api/channels/{id}

Header parameters

Parameter

Value

Accept

STRING REQUIRED

application/json

Authorization

STRING REQUIRED

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Path parameters

Parameter

Value

id

STRING REQUIRED

Zapier subscribe id stored in {{bundle.subscribeData.data.id}}

Response

200 OK

{
    "message": "Integration Channel deleted",
    "data": null
}

Perform list

Request

GET /api/zapier/{list}

Header parameters

Parameter

Value

Accept

STRING REQUIRED

application/json

Authorization

STRING REQUIRED

Base 64 encoded string containing the token value got it from login endpoint. The header value should be Bearer <token>

Path parameters

Parameter

Value

list

STRING REQUIRED

Posible values

  • customers

  • orders

  • shippings

  • subscriptions

  • surveys

  • transactions

  • transaction-histories

Response for customers

200 OK

{
  "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

200 OK

{
  "contact_id": 1,
  "agent_id": 1,
  "env": "test",
  "source": "admin",
  "completed_at": "2024-08-12T22:29:00Z",
  "is_shippable": true,
  "subtotal_pre_tax": 85862,
  "shipping_pre_tax": 84215,
  "subtotal": 53866,
  "discount": 66667,
  "shipping": 39421,
  "taxes": 20390,
  "total": 48818,
  "metadata": null,
  "recurrent": true,
  "created_at": "2024-08-12T22:29:00Z",
  "id": 88,
  "url": "https://thiio.thiio.test/admin#/?order_id=",
  "type": "sale_approved",
  "number": 46,
  "date": "2024-08-12",
  "subtotal_tax": 41,
  "shipping_tax": 54,
  "items": [
    {
      "id": "fd35db1d-727e-35f9-8d3f-36d350c25816",
      "plan": null,
      "hard_cost": 85,
      "unit_price": 973,
      "quantity": 23,
      "subtotal": 950,
      "discount": 90,
      "subtotal_tax": 8,
      "shipping": 55,
      "shipping_tax": 3,
      "total": 999,
      "offer": null,
      "product": {
        "id": "821de435-e877-365a-9d4f-f158078e8299",
        "product_variation_id": "018cbbac-9358-3aad-87c4-d9d751de3a9a",
        "name": "Qui maxime enim est.",
        "type": "digital",
        "sku": "et",
        "upc": 65,
        "ean": 20,
        "isbn": 3,
        "metadata": null
      }
    }
  ],
  "contact": {
    "id": "3313f76f-08aa-338c-b5cc-679a8ff0f271",
    "first_name": "Johnathon",
    "last_name": "Lockman",
    "email": "pthiel@hotmail.com",
    "phones": [
      {
        "number": "254-671-3466",
        "country": "IO",
        "default": false
      },
      {
        "number": "463-967-3313",
        "country": "NG",
        "default": true
      }
    ]
  },
  "agent": {
    "id": "6f0adc6d-d457-3c0e-b852-173540a06d44",
    "first_name": "Letitia",
    "last_name": "Kilback",
    "email": "yruecker@jacobi.com",
    "phones": [
      {
        "number": "+19522670267",
        "country": "PR",
        "default": false
      },
      {
        "number": "(947) 643-4856",
        "country": "SL",
        "default": true
      }
    ]
  },
  "address": {
    "id": "14aade11-3114-378b-9fb4-2c01fa7e0f68",
    "first_name": "Jazmyne",
    "last_name": "Carroll",
    "country": "AL",
    "state": "NM",
    "city": "Bogisichfort",
    "line": "67586 Nitzsche Shoals Suite 543",
    "line2": "961 Flatley Inlet",
    "zip_code": "69324",
    "references": null
  },
  "payment_method": {
    "id": "ad46ac3c-b37f-32ea-a2ed-608d88f8dcb5",
    "type": "card",
    "brand": "visa",
    "last4": 4242,
    "exp_month": 6,
    "exp_year": 2030,
    "address": {
      "id": "12902b93-1eed-3dde-ae4f-449c19468f98",
      "first_name": "Dagmar",
      "last_name": "Mayert",
      "country": "CD",
      "state": "OR",
      "city": "Luettgenhaven",
      "line": "10033 Kiehn Grove Suite 759",
      "line2": "552 Cesar Avenue Suite 009",
      "zip_code": "36500-9396",
      "references": null
    }
  },
  "gateway": {
    "id": "e6f95da3-cdaf-32d9-839e-238aa4227c39",
    "type": "magnam",
    "name": "Alberto Cruickshank"
  },
  "transactions": [
    {
      "id": "7d2fe6ea-0c91-31cb-b136-1ee0f3e9b363",
      "date": "2024-08-12 22:29:00",
      "external_gateway_id": "d231c37f-f3b9-3aea-b575-eb3003a0cfb7",
      "subtotal": 434,
      "discount": 39,
      "subtotal_tax": 54,
      "shipping": 20,
      "shipping_tax": 48,
      "total": 788,
      "coupon": null,
      "items": [
        {
          "id": "71cfb805-f334-3047-b6af-5678cda53191",
          "plan": null,
          "hard_cost": 47,
          "unit_price": 892,
          "quantity": 30,
          "subtotal": 762,
          "discount": 41,
          "subtotal_tax": 57,
          "shipping": 96,
          "shipping_tax": 64,
          "total": 484,
          "offer": null,
          "product": {
            "id": "6f745291-d064-314f-a1f5-415cd8fb2a43",
            "product_variation_id": "7af2ec1e-0086-37a9-a3be-cf8eea38a551",
            "name": "Rerum voluptas eum beatae nam.",
            "type": "physical",
            "sku": "ab",
            "upc": 67,
            "ean": 19,
            "isbn": 47,
            "metadata": null
          }
        }
      ],
      "page": null
    }
  ]
}

Response for shippings

200 OK

{
  "id": 2,
  "url": "https://www.gleichner.com/qui-animi-a-occaecati-ut-molestiae-voluptatem-cum",
  "number": 53,
  "date": "2024-08-12T22:35:24Z",
  "source": "admin",
  "env": "test",
  "recurrent": false,
  "subtotal": 81109,
  "discount": 74977,
  "subtotal_tax": 7,
  "shipping": 39,
  "shipping_tax": 68,
  "total": 11766,
  "coupon": null,
  "items": [
    {
      "id": "b6003b6b-dcc2-3e02-968a-6fa9eb8c72e2",
      "product": {
        "id": "eec20b5f-e396-3555-a485-d33c6838dcfc",
        "product_variation_id": "cd92206e-f20f-3a1a-ab2f-106443c032a1",
        "name": "Harum illo exercitationem.",
        "type": "digital",
        "sku": "maxime",
        "upc": 97,
        "ean": 11,
        "isbn": 85,
        "metadata": null
      },
      "plan": null,
      "hard_cost": 74,
      "unit_price": 109,
      "quantity": 21,
      "subtotal": 753,
      "discount": 34,
      "subtotal_tax": 46,
      "shipping": 35,
      "shipping_tax": 44,
      "total": 919,
      "offer": null
    }
  ],
  "contact": {
    "id": "713c8f98-b447-3e0e-97b9-04e94103cd2b",
    "first_name": "Coty",
    "last_name": "Cartwright",
    "email": "dooley.travis@aufderhar.com",
    "phones": [
      {
        "number": "1-219-209-1606",
        "country": "BR",
        "default": false
      },
      {
        "number": "+1-571-877-1535",
        "country": "KP",
        "default": true
      }
    ]
  },
  "agent": {
    "id": "720d3a08-9312-3a53-8336-c431d8069452",
    "first_name": "Moses",
    "last_name": "Schowalter",
    "email": "effie.rath@gmail.com",
    "phones": [
      {
        "number": "636.339.0523",
        "country": "AE",
        "default": true
      },
      {
        "number": "1-229-746-2842",
        "country": "VU",
        "default": false
      }
    ]
  },
  "address": {
    "id": "db697dd6-8af9-37c3-a7ce-a885c2336319",
    "first_name": "Arnold",
    "last_name": "Becker",
    "country": "JM",
    "state": "MS",
    "city": "South Ofelia",
    "line": "36865 Daniel Inlet",
    "line2": "23483 Bauch Lights",
    "zip_code": "61440",
    "references": null
  },
  "tracking": null,
  "payment_method": {
    "id": "8ecf2eb7-de39-3cde-ac7f-d30a2a1c08a3",
    "type": "card",
    "brand": "visa",
    "last4": 4242,
    "exp_month": 6,
    "exp_year": 2030,
    "address": {
      "id": "23c4239a-ed87-3e44-9217-0814b2f6bb00",
      "first_name": "Emerald",
      "last_name": "Harris",
      "country": "CV",
      "state": "MA",
      "city": "Schmidtside",
      "line": "840 Milton Mount Apt. 095",
      "line2": "3118 Bradtke Ports Suite 729",
      "zip_code": "05016",
      "references": null
    }
  },
  "gateway": {
    "id": "f063b5b2-1e4a-3ad1-a02c-951f913a7b84",
    "type": "et",
    "name": "Maxine Hyatt"
  },
  "funnel": null,
  "shippings": [
    {
      "id": "fa08baed-2f4d-3f66-993c-bcb483a21233",
      "carrier": "redpack",
      "tracking_number": 78598,
      "tracking_url": "http://www.pouros.com/",
      "external_id": "0134173c-aafb-3e14-98cf-d95ef6cb8af3",
      "items": [],
      "created_at": "2024-08-12 22:35:24"
    }
  ],
  "transactions": [
    {
      "id": "ec5d5313-73a6-36a0-a9dc-83bdbbed38ae",
      "date": "2024-08-12 22:35:24",
      "external_gateway_id": "3d8b0bc1-1971-3961-af37-18b5e116b426",
      "subtotal": 877,
      "discount": 46,
      "subtotal_tax": 81,
      "shipping": 73,
      "shipping_tax": 65,
      "total": 404,
      "coupon": null,
      "items": [
        {
          "id": "d70a6858-4cd3-3a99-9172-7379d183eddc",
          "product": {
            "id": "7b659d0b-5d4b-37e3-b3d1-0be5e7baa5be",
            "product_variation_id": "8a89d25c-1349-3125-8da0-d273951fdd2b",
            "name": "Aut repudiandae inventore mollitia.",
            "type": "digital",
            "sku": "exercitationem",
            "upc": 57,
            "ean": 98,
            "isbn": 51,
            "metadata": null
          },
          "plan": null,
          "hard_cost": 44,
          "unit_price": 31,
          "quantity": 47,
          "subtotal": 854,
          "discount": 16,
          "subtotal_tax": 56,
          "shipping": 87,
          "shipping_tax": 87,
          "total": 190,
          "offer": null
        }
      ]
    }
  ]
}

Response for subscriptions

200 OK

  • No labels