Signal setups
Create, read, update and delete the signals a client has set up.
A signal setup turns one signal template into a signal that watches for a client. Create one by naming a signal template (its signal_template_id, from Signal Templates) and giving the parameters that signal template describes in its setup.fields.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /api/v3/partner/workspaces/{partner_workspace_id}/signal-setups | Set up a signal for a client: create a new setup. |
| GET | /api/v3/partner/workspaces/{partner_workspace_id}/signal-setups | List a client's signal setups: browse what a client has set up. |
| GET | /api/v3/partner/workspaces/{partner_workspace_id}/signal-setups/{signal_setup_id} | Get a client's signal setup: retrieve one setup by ID. |
| PATCH | /api/v3/partner/workspaces/{partner_workspace_id}/signal-setups/{signal_setup_id} | Update a client's signal setup: change its parameters, schedule or name, or pause or resume it. |
| DELETE | /api/v3/partner/workspaces/{partner_workspace_id}/signal-setups/{signal_setup_id} | Delete a client's signal setup: remove a setup. |
How a signal setup reads
- The signal template is embedded. Every response carries the whole signal template under
signal_template, without itssetupblock. When you create a setup you still send itssignal_template_id. parametersare the parameters as applied. Every default is filled in at creation, stored and returned, so a read shows exactly what the setup runs with. The page of each signal template lists its parameters and defaults.scheduleis"weekly"ornull.null, or a missingschedule, means no schedule: the setup runs only when you launch a signal run.- A setup belongs to one persona. See Persona required.
- You can set up the same signal several times for one persona, for example once per set of keywords.
statusisenabledordisabled. Pause or resume a setup withPATCH.