CloudCard Zapier API Documentation

CloudCard Zapier API Documentation

Overview

CloudCard’s Zapier integration allows you to seamlessly connect your CloudCard account with thousands of apps on Zapier.

This integration makes it easy to:

• Sync leads from CloudCard to external CRMs or tools.
• Automate workflows triggered by new CloudCard activity.
• Keep your systems up to date without manual data entry.

The integration uses OAuth 2.0 authentication for secure access.

Once connected, Zapier can access specific CloudCard API endpoints to retrieve data and perform actions.

Authentication

The CloudCard Zapier integration uses OAuth 2.0 via Laravel Passport to authorize access.

Flow:

1.     In Zapier, the user clicks Connect CloudCard Account.

2.     The user is redirected to CloudCard’s OAuth authorization screen:

3.      https://app.cloudcard.co.za/oauth/authorize

4.     The user logs in and approves Zapier’s access.

5.     Zapier receives an access token from:

6.      https://app.cloudcard.co.za/oauth/token

7.     Zapier can now use the access token to call CloudCard API endpoints.

Base URL

All API requests are made to the following base URL:

https://app.cloudcard.co.za/api

Endpoints

1. GET /me

Purpose:

Used by Zapier after authentication to verify the connected CloudCard account and fetch basic user and organisation information.

Endpoint:

GET /api/me

Headers:

Authorization: Bearer <access_token>

Accept: application/json

Example Request:

GET /api/me HTTP/1.1

Host: app.cloudcard.co.za

Authorization: Bearer abc123xyz

Accept: application/json

Example Response:

{

"user": {

"first_name": "John",

"last_name": "Doe",

"email": "john@example.com"

},

"organisation_name": "Company"

}

Behaviour Notes:

• The endpoint automatically determines which organisation the user belongs to by checking:
  1. If the user has a direct organisation link.
  2. If they have cards associated with an organisation.
  3. If they are linked to leads in an organisation.
  4. If none of the above exist, the first organisation they belong to is used.
• If no connection record exists, one is created automatically.

2. GET /zapier/leads

Purpose:

Zapier polls this endpoint periodically to retrieve new lead data for triggers.

Endpoint:

GET /api/zapier/leads

Headers:

Authorization: Bearer <access_token>

Accept: application/json

Example Request:

GET /api/zapier/leads HTTP/1.1

Host: app.cloudcard.co.za

Authorization: Bearer abc123xyz

Accept: application/json

Example Response:

[

{

"id": "lead-uuid-123",

"first_name": "Jane",

"last_name": "Smith",

"email": "jane@business.com",

"phone": "+272345678912",

"company": "Jane's Bakery",

"created_at": "2025-09-05T10:15:00Z"

},

{

"id": "lead-uuid-456",

"first_name": "John",

"last_name": "Doe",

"email": "john@startup.com",

"phone": "+271234567890",

"company": "John’s Repair Shop",

"created_at": "2025-09-05T10:30:00Z"

}

]

Notes:

• Only new leads since the last poll are returned.
• Each lead includes:
  • id – unique identifier
  • first_name and last_name
  • email
  • phone
  • company
  • created_at timestamp

Error Handling

CloudCard returns standard HTTP status codes to indicate success or failure.

Example Error Response:

{

"error": "Invalid token or authentication expired."

}

Zapier Setup Guide

Steps for Users:

1. In Zapier, search for CloudCard and click Connect.
2. You will be redirected to the CloudCard OAuth screen.
3. Log in with your CloudCard credentials.
4. Approve Zapier to access your account.
5. Zapier verifies the connection using the /me endpoint.
6. Start creating Zaps using CloudCard triggers, such as:
   • New lead created in CloudCard
   • Card shared with a new contact

Example Workflow

Goal: Automatically send new CloudCard leads to Google Sheets.

1. Trigger: New Lead in CloudCard (Zapier polls /api/zapier/leads).
2. Action: Create Row in Google Sheets.
3. Every new lead is added to the spreadsheet instantly.

Security

• OAuth 2.0 ensures secure authorization and token management.
• All API requests must be made over HTTPS.
• Tokens expire and must be refreshed via Zapier’s built-in mechanism.
• No passwords are ever shared directly with Zapier.

Support

If you experience issues with the CloudCard Zapier integration, please contact:

• Email: support@cloudcard.digital
• Phone: +27878221153
• Website: https://cloudcard.digital