Authenticate requests securely using OAuth 2.0 and token-based headers. Never leak tokens and rotate credentials regularly.
In Serene, you authorize access to the Users API with app credentials. Store client IDs securely and use scopes like socialplanner/tag.readonly to limit access.
Endpoints connected to the Users API in Serene include: GET /social-media-posting/:locationId/tags; POST /social-media-posting/:locationId/tags/details; socialplanner/statistics.readonly; POST /social-media-posting/statistics. Additional endpoints are available in the API docs.
Trigger: When you need the current tags for a location to drive content or insights.
Actions: Call GET /social-media-posting/:locationId/tags and map locationId to tags in Serene.
GET /social-media-posting/:locationId/tags
Key fields: locationId, tags
Trigger: When enriched tag details are needed for deeper insights.
Actions: POST to /social-media-posting/:locationId/tags/details and import details into Serene
POST /social-media-posting/:locationId/tags/details
Key fields: locationId, details
Trigger: When you need system-wide metrics for dashboards or reporting.
Actions: GET socialplanner/statistics.readonly and optionally POST to /social-media-posting/statistics for custom reports.
GET socialplanner/statistics.readonly
Key fields: none required; uses account-level scope.
Benefit 1: Centralized data access from the Users API directly in Serene workflows.
Benefit 2: Real-time insights via up-to-date tags and statistics.
Benefit 3: Simple, token-based authentication and scoped access for security.
Key elements and processes you’ll encounter when integrating the Users API with Serene include endpoints, authentication, data mapping, and error handling.
API stands for Application Programming Interface — a set of endpoints you call to read or write data.
OAuth 2.0 is a token-based authorization framework that grants access without sharing user credentials.
Webhook is a way for the API to send real-time events to Serene when data changes occur.
Rate Limit defines the maximum number of requests allowed in a given time window to protect the API and ensure stable performance.
Automate tagging and metadata collection by syncing tags from the Users API into Serene dashboards.
Combine tags and statistics feeds from the Users API to create live reporting in Serene.
Set up alerts in Serene when important tag changes or statistics thresholds occur.
Obtain OAuth tokens and configure app credentials for Serene.
Set up endpoint mappings for the tags and statistics endpoints.
Run tests and verify data flow before going live.
The best approach is to start with the essential endpoints for tags and statistics to establish a data flow. Use Serene to manage credentials securely and test in a sandbox. As you scale, add additional endpoints to extend coverage. Each integration should be locked down with scoped access to minimize risk. Two paragraphs of guidance help keep your setup clear and maintainable.
Initial setup should include GET /social-media-posting/:locationId/tags and GET socialplanner/statistics.readonly to surface core data. These endpoints give you immediate visibility into location tags and overall metrics. Then you can progressively map additional endpoints like tags/details as your needs grow.
Use OAuth 2.0 tokens and rotate them regularly. Store tokens securely, never in client-side code, and restrict scopes to the minimum necessary one (e.g., socialplanner/tag.readonly). Regularly review access logs and implement token renewal automation where possible.
Yes. The Users API includes a statistics endpoint that can provide read-only metrics. For live dashboards, you can also POST to /social-media-posting/statistics to submit computed stats. Ensure rate limits are respected when polling data.
Data mapping involves aligning locationId, tags, and statistics fields between the API response payloads and Serene’s data model. Use consistent field names and validate data types during ETL to prevent mismatches.
Rate limits depend on your plan and the endpoint. Plan for bursts by implementing backoff strategies and caching where appropriate. If you approach limits, stagger requests or use batch operations when available.
API documentation for the Users API is available in your developer portal. Look for endpoint references, authentication guidance, and examples. If you’re using Serene, the app connector docs will show example mappings and test cases.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers