Utilizing our Gateway API with your Copywriting data enables automated data synchronization and streamlined copywriting operations within Creative Force.
This article covers API setup and authentication, pre-populating content fields, triggering tasks programmatically, and utilizing webhooks for real-time updates.
Gateway API Setup
To get started, you’ll need to register an app with the Creative Force Gateway API.
Go to Studio Settings > Integrations > Registered Apps.
Click Register App.
Here, you can choose between two methods:
Once your app is registered, you’ll get tokens to share with your Copywriting team.
📝 Note: Tokens are valid for one hour after they are generated.
Gateway API + Webhook Functions
How to use the Gateway API to connect and process your data is ultimately up to you. If you’re looking for example requests, responses, or endpoint details, check out our API Documentation.
Creative Force uses webhooks to send updates about Copywriting Work Units. These events keep you informed about status changes and more. For details, check out our Webhook Documentation.
In the next sections, we'll cover two popular functions to utilize in Copywriting productions with the Gateway API.
Pre-Populate Content In Fields
You can populate content directly into Copywriting Fields, allowing your copywriters to work with accurate, preloaded information, saving time and leaving more room for creativity.
Use this endpoint to pre-populate content for tasks in 'Backlog' status:
The following fields are supported to be pre-populated: Single Line Text, Text Area, Care Instructions, Color, and Predefined List.
📝 Note:
Hidden fields can’t be pre-populated.
You can include up to 20 items in an array per request.
Pre-populated content will be removed if:
Task’s Style Guide is changed or overwritten.
Task is updated to the latest Style Guide version.
Task is applied, updated, and reset to Copywriting step.
Triggering Tasks via Gateway API
Want to move a Copywriting Work Unit from “Backlog” to “To Do”?
In Gamma, select the Task Initiation > Trigger > Via Gateway API:
2. Use this endpoint to initiate the trigger: