"Subscriptions" Endpoints - POST Creates a subscription

Tech Discussions Webhooks API
, , , ,
1 
https://api.track.toggl.com/webhooks/api/v1/subscriptions/{workspace_id}

Creates a subscription for the requested workspace ID.

  • cURL
  • Go
  • Ruby
  • JavaScript
  • Python
  • Rust
extern crate tokio;extern crate serde_json;use reqwest::{Client};use reqwest::header::{CONTENT_TYPE};#[tokio::main]async fn main() -> Result<(), reqwest::Error> {  let client = Client::new();  let json = client.request(Method::POST, "https://api.track.toggl.com/webhooks/api/v1/subscriptions/{workspace_id}".to_string()).json(&serde_json::json!(\{"created_at":"string","deleted_at":"string","description":"string","enabled":"boolean","event_filters":[\{\}],"has_pending_events":"boolean","secret":"string","subscription_id":"integer","updated_at":"string","url_callback":"string","user_id":"integer","validated_at":"string","workspace_id":"integer"\}))  .header(CONTENT_TYPE, "application/json")  .send()  .await?  .json()  .await?;    println!("{:#?}", json);  Ok(())}

Parameters​

Path​

name type required description
workspace_id integer true Numeric ID of the workspace

Body​

Name Type Description
created_at string -
deleted_at string -
description string -
enabled boolean -
event_filters Array of SubscriptionEventFilter -
has_pending_events boolean -
secret string -
subscription_id integer -
updated_at string -
url_callback string -
user_id integer -
validated_at string -
workspace_id integer -

Response​

200​

Name Type Description
created_at string -
deleted_at string -
description string -
enabled boolean -
event_filters Array of SubscriptionEventFilter -
has_pending_events boolean -
secret string -
subscription_id integer -
updated_at string -
url_callback string -
user_id integer -
validated_at string -
workspace_id integer -

400​

Possible error messages:

  • URL endpoint {url_callback} responded with status {HTTP status code} instead of 200
  • URL endpoint {url_callback} request failed with error: {HTTP error}
  • User {user_id} already reached the limit of {allowed limit} enabled subscriptions for workspace {workspace_id}
  • Subscription description must not be empty
  • Subscription description ‘{description}’ is already in use for workspace {workspace_id}
  • The list of event filters must not be empty
  • The limit of {allowed limit} event filters for your subscription has been exceeded as you’re trying to set {number of filters} filters
  • The following event filter appears more than once for your subscription: {subscription_id}
  • The entity field for each subscription event filter must be non-empty
  • The value ‘{entity}’ for the filter entity can only contain letters, numbers and ‘_’ or be ‘*’ to match all entities
  • The action field for each subscription event filter must be non-empty
  • The value ‘{action}’ for the filter action can only contain letters, numbers and ‘_’ or be ‘*’ to match all actions
  • Invalid value ‘{action}’ for event filter action

403​

User not found/accessible for workspace

500​

Internal Server Error