Use your API key with the scope socialplanner/tag.readonly to securely access tag data from Workiz. Store credentials securely and rotate keys regularly.
Link your Workiz account to enable data sharing with the Users API. Use OAuth or API key-based auth as supported by the App Connector.
Endpoint 1: GET /social-media-posting/:locationId/tags Endpoint 2: POST /social-media-posting/:locationId/tags/details Endpoint 3: socialplanner/statistics.readonly Endpoint 4: POST /social-media-posting/statistics
Trigger: when a new or updated tag is created in Workiz, push the tag data to the Users API.
Actions: create or update corresponding tag records in the Users API; update related customer or location data.
POST /social-media-posting/:locationId/tags/details
locationId, tagsDetails, timestamp
Trigger: on a schedule or when Workiz statistics change, update analytics in the Users API.
POST /social-media-posting/statistics
locationId, statisticsPayload, timestamp
Trigger: tag status changes in Workiz trigger automated actions in the Users API.
Actions: create tasks, update records, or trigger follow-ups in Workiz from Users API events.
GET /social-media-posting/:locationId/tags
locationId, tagId, status
Drag-and-drop automation to sync data between Workiz and the Users API without writing code.
Pre-built templates and actions speed onboarding and deployment.
Real-time data updates improve customer insights without custom coding.
This glossary defines core concepts and data-flow elements used in this integration between Workiz and the Users API.
An authorization framework that enables secure access to APIs without sharing user credentials; tokens expire and scopes control permissions.
A secret token used to authenticate API requests, typically sent in headers.
A callback URL that notifies your system when events occur in another service.
The data delivered in an API request or event, usually JSON.
Automatically segment customers in Workiz based on Users API tags and trigger personalized follow-ups.
Display real-time sync status between Workiz and the Users API in a centralized dashboard.
Schedule exports of Workiz data enriched by Users API to teammates via email or Slack.
Request or generate an API key and ensure the proper scope (socialplanner/tag.readonly) is granted.
Enter the endpoint paths you will use and set up webhooks for real-time updates between Workiz and the Users API.
Run tests, verify data flows, and roll out to production with monitoring in place.
You authenticate using your API credentials in the App Connector. Use the scope socialplanner/tag.readonly to access tag data. Keep credentials secure and rotate keys regularly. If your app uses OAuth, complete the authorization flow to obtain access tokens.
Typical syncing involves retrieving and pushing tag details, location associations, and simple statistics. Start with endpoints 1-4 and expand as needed. Plan data mappings between Workiz fields and the Users API fields.
No-code templates in the App Connector let you set up most workflows. Some scenarios may require light scripting for custom field mapping or conditional logic, but many use cases can be achieved with pre-built actions.
You can sync tags, location data, and basic statistics. Depending on needs, you can push updates from Workiz to the Users API and pull analytics back for dashboards.
Implement retry policies, exponential backoff, and alerting. The App Connector retries failed calls, logs errors, and surfaces them in the dashboard for quick remediation.
Rate limits depend on the endpoints; monitor the API documentation for current quotas. If you hit limits, stagger requests or implement caching where appropriate.
Integration logs and error reports are available in the App Connector dashboard; enable webhook history and review failed payloads for debugging.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
