Create a Custom Action

Create a Custom Action belonging to A Team

SecurityJWT or DeveloperToken or OAuth2

Request

path Parameters

team_id

required

string <uuid>

Request Body schema: application/json

Action to create or update

url required	string HTTPS endpoint to deliver Action events to
name required	string Name of the custom Action
event required	string Arbitrary event name to include in custom Action webhook payloads
description required	string Description of the custom Action
allow_collaborators	boolean Default: false
include	string Any associations to include in the response

Responses

200

Action success response

Response Schema: application/json

active	boolean
allow_collaborators	boolean
creator_id	string <uuid>
deleted_at	string <date-time>
description	string
event	string
id	string <uuid>
image	string
inserted_at	string <date-time>
name	string
	object (Team)
team_id	string <uuid>
updated_at	string <date-time>
upload_url	string
url	string
	object (Webhook)

401

Unauthorized response

404

Not Found response

post/v2/teams/{team_id}/actions

Request samples

application/json

{"description": "string",
"event": "string",
"name": "string",
"url": "string"
}

Response samples

application/json

{"active": true,
"allow_collaborators": true,
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"deleted_at": "2019-08-24T14:15:22Z",
"description": "string",
"event": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"image": "string",
"inserted_at": "2019-08-24T14:15:22Z",
"name": "string",
"team": {"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"disable_sbwm_internally": false,
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"storage": 0,
"default_font_color": "string",
"access": "private",
"font_color": "string",
"user_role": { },
"file_count": 0,
"default_session_watermark_template": {"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"app_default": false,
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"watermark_blocks": [{"alpha": 0.5,
"data_points": [{"order": 0,
"type": "email",
"value": "string"
}
],
"font_size": "small",
"name": "string",
"position": "top_left",
"position_reference_point": "top_left",
"position_x": 0,
"position_y": 0,
"scroll_text": "none",
"text_alignment": "left",
"text_color": "#FFFFFF",
"text_shadow": false
}
]
},
"link": "string",
"asset_lifecycle_policy": 0,
"upload_url": "string",
"admin_only_actions": {"lifecycle": false
},
"deleted_at": "2019-08-24T14:15:22Z",
"default_background_color": "string",
"storage_limit": 0,
"location": "string",
"name": "string",
"default_color": "string",
"slack_webhook": { },
"image_64": "string",
"archived_storage": 0,
"image_128": "string",
"solo": false,
"account": {"invoice_emails": ["string"
],
"city": "string",
"account_default_color": "string",
"company_name": "string",
"storage": 0,
"file_count": 0,
"owner": {"digest_frequency": "string",
"features_seen": null,
"profile_image_original": null,
"image_32": "string",
"image_128": "string",
"from_google": true,
"mfa_enforced_at": "string",
"email": "string",
"bio": null,
"name": "string",
"image_64": "string",
"timezone_value": "string",
"account_id": "string",
"updated_at": "string",
"image_256": "string",
"_type": "string",
"user_hash": "string",
"context": null,
"upload_url": "string",
"location": null,
"phone": null,
"deleted_at": null,
"profile_image": "string",
"first_login_at": "string",
"joined_via": "string",
"email_confirm_by": null,
"id": "string",
"next_digest_date": "string",
"email_preferences": null,
"last_seen": "string",
"inserted_at": "string",
"roles": {"admin": true,
"id": "string",
"sales": true,
"support": true
},
"user_default_color": "string"
},
"upload_url": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"line1": "string",
"postal_code": "string",
"vat": "string",
"company_address": "string",
"lifetime_file_count": 0,
"state": "string",
"teams": [{ }
],
"image_64": "string",
"archived_storage": 0,
"image_128": "string",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"user_count": 0,
"locked_at": "2019-08-24T14:15:22Z",
"image": "string",
"team_count": 0,
"collaborator_role_count": 0,
"billing_emails": "string",
"image_32": "string",
"unpaid_at": "2019-08-24T14:15:22Z",
"inserted_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"project_count": 0,
"duration": 0,
"delinquent_at": "2019-08-24T14:15:22Z",
"collaborator_count": 0,
"plan": {"archived_storage_limit": 0,
"autoscaling": true,
"available_features": {"archival_storage": true,
"custom_branded_emails": true,
"custom_branded_presentations": true,
"reel_player": true,
"secure_sharing": true,
"session_based_watermarking": true,
"team_only_comments": true
},
"collaborator_limit": 0,
"cost": 0,
"default_plan": true,
"deleted_at": "2019-08-24T14:15:22Z",
"enterprise": true,
"file_limit": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inserted_at": "2019-08-24T14:15:22Z",
"lifetime_file_limit": 0,
"member_limit": 0,
"name": "string",
"payment_method": "stripe",
"period": "monthly",
"project_limit": 0,
"storage_limit": 0,
"team_limit": 0,
"tier": "free",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user_limit": 0,
"user_max": 0,
"version": 0
},
"watermark": {"image": {"alpha": 0.5,
"image": {"bucket": "string",
"key": "string",
"type": "image/jpeg",
"uploaded": false
},
"position": "top_left"
},
"text": {"alpha": 0.5,
"lines": ["string"
],
"position": "top"
}
},
"folder_count": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"display_name": "string",
"country": "string",
"subscription": {"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"archived_storage_limit": 0,
"balance": 0,
"cancellation_option": "string",
"cancellation_reason": "string",
"cancelled_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inserted_at": "2019-08-24T14:15:22Z",
"last_payment_at": "2019-08-24T14:15:22Z",
"member_limit": 0,
"next_bill_at": "2019-08-24T14:15:22Z",
"on_trial": true,
"plan": {"archived_storage_limit": 0,
"autoscaling": true,
"available_features": {"archival_storage": true,
"custom_branded_emails": true,
"custom_branded_presentations": true,
"reel_player": true,
"secure_sharing": true,
"session_based_watermarking": true,
"team_only_comments": true
},
"collaborator_limit": 0,
"cost": 0,
"default_plan": true,
"deleted_at": "2019-08-24T14:15:22Z",
"enterprise": true,
"file_limit": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inserted_at": "2019-08-24T14:15:22Z",
"lifetime_file_limit": 0,
"member_limit": 0,
"name": "string",
"payment_method": "stripe",
"period": "monthly",
"project_limit": 0,
"storage_limit": 0,
"team_limit": 0,
"tier": "free",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user_limit": 0,
"user_max": 0,
"version": 0
},
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"promotion_expires_at": "2019-08-24T14:15:22Z",
"promotion_id": "27271a4f-601a-4379-9d7d-c9febeff12e4",
"requires_autoscaling": true,
"storage_limit": 0,
"subscription_end_at": "2019-08-24T14:15:22Z",
"total_archived_storage_limit": 0,
"total_lifetime_file_limit": 0,
"total_member_limit": 0,
"total_project_limit": 0,
"total_storage_limit": 0,
"total_user_limit": 0,
"updated_at": "2019-08-24T14:15:22Z",
"user_limit": 0
},
"account_members": [{"accepted_at": "2019-08-24T14:15:22Z",
"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"declined_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"inserted_at": "2019-08-24T14:15:22Z",
"role": "admin",
"updated_at": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
],
"frames": 0,
"member_count": 0,
"image_256": "string"
},
"image_32": "string",
"inserted_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"project_count": 0,
"duration": 0,
"team_image": "string",
"collaborator_count": 0,
"bio": "string",
"color": "string",
"email_branding": {"accent_color": "string",
"background_color": "string",
"image": {"bucket": "string",
"key": "string",
"type": "image/jpeg",
"uploaded": false
}
},
"folder_count": 0,
"dark_theme": false,
"default_session_watermark_template_id": "cfb3efe2-1061-4d0c-8f9c-90a094c1a06d",
"session_watermark_templates": [{"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"app_default": false,
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"watermark_blocks": [{"alpha": 0.5,
"data_points": [{"order": null,
"type": null,
"value": null
}
],
"font_size": "small",
"name": "string",
"position": "top_left",
"position_reference_point": "top_left",
"position_x": 0,
"position_y": 0,
"scroll_text": "none",
"text_alignment": "left",
"text_color": "#FFFFFF",
"text_shadow": false
}
]
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"member_limit": 0,
"frames": 0,
"member_count": 0,
"image_256": "string",
"background_color": "string"
},
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"updated_at": "2019-08-24T14:15:22Z",
"upload_url": "string",
"url": "string",
"webhook": {"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"active": true,
"app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
"deleted_at": "2019-08-24T14:15:22Z",
"events": ["project.created"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inserted_at": "2019-08-24T14:15:22Z",
"name": "string",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"secret": "string",
"team": {"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"disable_sbwm_internally": false,
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"storage": 0,
"default_font_color": "string",
"access": "private",
"font_color": "string",
"user_role": { },
"file_count": 0,
"default_session_watermark_template": {"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"app_default": false,
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"watermark_blocks": [{"alpha": 0.5,
"data_points": [{"order": null,
"type": null,
"value": null
}
],
"font_size": "small",
"name": "string",
"position": "top_left",
"position_reference_point": "top_left",
"position_x": 0,
"position_y": 0,
"scroll_text": "none",
"text_alignment": "left",
"text_color": "#FFFFFF",
"text_shadow": false
}
]
},
"link": "string",
"asset_lifecycle_policy": 0,
"upload_url": "string",
"admin_only_actions": {"lifecycle": false
},
"deleted_at": "2019-08-24T14:15:22Z",
"default_background_color": "string",
"storage_limit": 0,
"location": "string",
"name": "string",
"default_color": "string",
"slack_webhook": { },
"image_64": "string",
"archived_storage": 0,
"image_128": "string",
"solo": false,
"account": {"invoice_emails": ["string"
],
"city": "string",
"account_default_color": "string",
"company_name": "string",
"storage": 0,
"file_count": 0,
"owner": {"digest_frequency": "string",
"features_seen": null,
"profile_image_original": null,
"image_32": "string",
"image_128": "string",
"from_google": true,
"mfa_enforced_at": "string",
"email": "string",
"bio": null,
"name": "string",
"image_64": "string",
"timezone_value": "string",
"account_id": "string",
"updated_at": "string",
"image_256": "string",
"_type": "string",
"user_hash": "string",
"context": null,
"upload_url": "string",
"location": null,
"phone": null,
"deleted_at": null,
"profile_image": "string",
"first_login_at": "string",
"joined_via": "string",
"email_confirm_by": null,
"id": "string",
"next_digest_date": "string",
"email_preferences": null,
"last_seen": "string",
"inserted_at": "string",
"roles": {"admin": true,
"id": "string",
"sales": true,
"support": true
},
"user_default_color": "string"
},
"upload_url": "string",
"deleted_at": "2019-08-24T14:15:22Z",
"line1": "string",
"postal_code": "string",
"vat": "string",
"company_address": "string",
"lifetime_file_count": 0,
"state": "string",
"teams": [{ }
],
"image_64": "string",
"archived_storage": 0,
"image_128": "string",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"user_count": 0,
"locked_at": "2019-08-24T14:15:22Z",
"image": "string",
"team_count": 0,
"collaborator_role_count": 0,
"billing_emails": "string",
"image_32": "string",
"unpaid_at": "2019-08-24T14:15:22Z",
"inserted_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"project_count": 0,
"duration": 0,
"delinquent_at": "2019-08-24T14:15:22Z",
"collaborator_count": 0,
"plan": {"archived_storage_limit": 0,
"autoscaling": true,
"available_features": {"archival_storage": true,
"custom_branded_emails": true,
"custom_branded_presentations": true,
"reel_player": true,
"secure_sharing": true,
"session_based_watermarking": true,
"team_only_comments": true
},
"collaborator_limit": 0,
"cost": 0,
"default_plan": true,
"deleted_at": "2019-08-24T14:15:22Z",
"enterprise": true,
"file_limit": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inserted_at": "2019-08-24T14:15:22Z",
"lifetime_file_limit": 0,
"member_limit": 0,
"name": "string",
"payment_method": "stripe",
"period": "monthly",
"project_limit": 0,
"storage_limit": 0,
"team_limit": 0,
"tier": "free",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user_limit": 0,
"user_max": 0,
"version": 0
},
"watermark": {"image": {"alpha": 0.5,
"image": {"bucket": "string",
"key": "string",
"type": "image/jpeg",
"uploaded": false
},
"position": "top_left"
},
"text": {"alpha": 0.5,
"lines": ["string"
],
"position": "top"
}
},
"folder_count": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"display_name": "string",
"country": "string",
"subscription": {"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"archived_storage_limit": 0,
"balance": 0,
"cancellation_option": "string",
"cancellation_reason": "string",
"cancelled_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inserted_at": "2019-08-24T14:15:22Z",
"last_payment_at": "2019-08-24T14:15:22Z",
"member_limit": 0,
"next_bill_at": "2019-08-24T14:15:22Z",
"on_trial": true,
"plan": {"archived_storage_limit": 0,
"autoscaling": true,
"available_features": {"archival_storage": true,
"custom_branded_emails": true,
"custom_branded_presentations": true,
"reel_player": true,
"secure_sharing": true,
"session_based_watermarking": true,
"team_only_comments": true
},
"collaborator_limit": 0,
"cost": 0,
"default_plan": true,
"deleted_at": "2019-08-24T14:15:22Z",
"enterprise": true,
"file_limit": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inserted_at": "2019-08-24T14:15:22Z",
"lifetime_file_limit": 0,
"member_limit": 0,
"name": "string",
"payment_method": "stripe",
"period": "monthly",
"project_limit": 0,
"storage_limit": 0,
"team_limit": 0,
"tier": "free",
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user_limit": 0,
"user_max": 0,
"version": 0
},
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"promotion_expires_at": "2019-08-24T14:15:22Z",
"promotion_id": "27271a4f-601a-4379-9d7d-c9febeff12e4",
"requires_autoscaling": true,
"storage_limit": 0,
"subscription_end_at": "2019-08-24T14:15:22Z",
"total_archived_storage_limit": 0,
"total_lifetime_file_limit": 0,
"total_member_limit": 0,
"total_project_limit": 0,
"total_storage_limit": 0,
"total_user_limit": 0,
"updated_at": "2019-08-24T14:15:22Z",
"user_limit": 0
},
"account_members": [{"accepted_at": "2019-08-24T14:15:22Z",
"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"declined_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"inserted_at": "2019-08-24T14:15:22Z",
"role": "admin",
"updated_at": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
],
"frames": 0,
"member_count": 0,
"image_256": "string"
},
"image_32": "string",
"inserted_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"project_count": 0,
"duration": 0,
"team_image": "string",
"collaborator_count": 0,
"bio": "string",
"color": "string",
"email_branding": {"accent_color": "string",
"background_color": "string",
"image": {"bucket": "string",
"key": "string",
"type": "image/jpeg",
"uploaded": false
}
},
"folder_count": 0,
"dark_theme": false,
"default_session_watermark_template_id": "cfb3efe2-1061-4d0c-8f9c-90a094c1a06d",
"session_watermark_templates": [{"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"app_default": false,
"creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"watermark_blocks": [{"alpha": 0.5,
"data_points": [null
],
"font_size": "small",
"name": "string",
"position": "top_left",
"position_reference_point": "top_left",
"position_x": 0,
"position_y": 0,
"scroll_text": "none",
"text_alignment": "left",
"text_color": "#FFFFFF",
"text_shadow": false
}
]
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"member_limit": 0,
"frames": 0,
"member_count": 0,
"image_256": "string",
"background_color": "string"
},
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
}

Create a Custom Action

path Parameters

Request Body schema: application/json

Response Schema: application/json

Overview

Integrations

Company

Support