Update webhook

PUT

https://api.frame.io/v2/hooks/:hook_id

PUT

/v2/hooks/:hook_id

import requests
url = "https://api.frame.io/v2/hooks/eefb57e0-79f2-4bc7-9b70-99fbc175175c"
payload = {
    "name": "string",
    "url": "string"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

{
  "account_id": "string",
  "active": true,
  "app_id": "string",
  "deleted_at": "2024-01-15T09:30:00Z",
  "events": [
    "project.created"
  ],
  "id": "string",
  "inserted_at": "2024-01-15T09:30:00Z",
  "name": "string",
  "project_id": "string",
  "secret": "string",
  "team": {
    "account_id": "string",
    "disable_sbwm_internally": false,
    "creator_id": "string",
    "storage": 0,
    "default_font_color": "string",
    "access": "private",
    "font_color": "string",
    "user_role": {},
    "file_count": 0,
    "default_session_watermark_template": {
      "account_id": "string",
      "app_default": false,
      "creator_id": "string",
      "id": "string",
      "name": "string",
      "watermark_blocks": [
        {
          "alpha": 0.5,
          "data_points": [
            {
              "order": 1,
              "type": "email",
              "value": "string"
            }
          ],
          "font_size": "medium",
          "name": "string",
          "position": "top_left",
          "position_reference_point": "top_left",
          "position_x": 1,
          "position_y": 1,
          "scroll_text": "none",
          "text_alignment": "left",
          "text_color": "#FFFFFF",
          "text_shadow": false
        }
      ]
    },
    "link": "string",
    "asset_lifecycle_policy": 1,
    "upload_url": "string",
    "admin_only_actions": {
      "lifecycle": false
    },
    "deleted_at": "2024-01-15T09:30:00Z",
    "default_background_color": "string",
    "storage_limit": 1,
    "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": 1,
      "file_count": 1,
      "owner": {
        "digest_frequency": "string",
        "image_32": "string",
        "image_128": "string",
        "from_google": true,
        "mfa_enforced_at": "string",
        "email": "string",
        "name": "string",
        "image_64": "string",
        "timezone_value": "string",
        "account_id": "string",
        "updated_at": "string",
        "image_256": "string",
        "_type": "string",
        "user_hash": "string",
        "upload_url": "string",
        "profile_image": "string",
        "first_login_at": "string",
        "joined_via": "string",
        "id": "string",
        "next_digest_date": "string",
        "last_seen": "string",
        "inserted_at": "string",
        "from_adobe": true,
        "avatar_color": "string",
        "highest_account_role": "string",
        "integrations": [
          "string"
        ],
        "roles": {
          "admin": true,
          "id": "string",
          "sales": true,
          "support": true,
          "service_desk": true
        },
        "user_default_color": "string"
      },
      "upload_url": "string",
      "deleted_at": "2024-01-15T09:30:00Z",
      "line1": "string",
      "postal_code": "string",
      "vat": "string",
      "company_address": "string",
      "lifetime_file_count": 1,
      "state": "string",
      "teams": [
        null
      ],
      "image_64": "string",
      "archived_storage": 1,
      "image_128": "string",
      "owner_id": "string",
      "user_count": 1,
      "locked_at": "2024-01-15T09:30:00Z",
      "image": "string",
      "team_count": 1,
      "collaborator_role_count": 1,
      "billing_emails": "string",
      "image_32": "string",
      "unpaid_at": "2024-01-15T09:30:00Z",
      "inserted_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "project_count": 1,
      "duration": 1,
      "delinquent_at": "2024-01-15T09:30:00Z",
      "collaborator_count": 1,
      "plan": {
        "archived_storage_limit": 1,
        "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": 1,
        "cost": 1,
        "default_plan": true,
        "deleted_at": "2024-01-15T09:30:00Z",
        "enterprise": true,
        "file_limit": 1,
        "id": "string",
        "inserted_at": "2024-01-15T09:30:00Z",
        "lifetime_file_limit": 1,
        "member_limit": 1,
        "name": "string",
        "payment_method": "stripe",
        "period": "monthly",
        "project_limit": 1,
        "storage_limit": 1,
        "team_limit": 1,
        "tier": "free",
        "title": "string",
        "updated_at": "2024-01-15T09:30:00Z",
        "user_limit": 1,
        "user_max": 1,
        "version": 1
      },
      "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": 1,
      "id": "string",
      "display_name": "string",
      "country": "string",
      "subscription": {
        "account_id": "string",
        "archived_storage_limit": 1,
        "balance": 1,
        "cancellation_option": "string",
        "cancellation_reason": "string",
        "cancelled_at": "2024-01-15T09:30:00Z",
        "deleted_at": "2024-01-15T09:30:00Z",
        "id": "string",
        "inserted_at": "2024-01-15T09:30:00Z",
        "last_payment_at": "2024-01-15T09:30:00Z",
        "member_limit": 1,
        "next_bill_at": "2024-01-15T09:30:00Z",
        "on_trial": true,
        "plan": {
          "archived_storage_limit": 1,
          "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": 1,
          "cost": 1,
          "default_plan": true,
          "deleted_at": "2024-01-15T09:30:00Z",
          "enterprise": true,
          "file_limit": 1,
          "id": "string",
          "inserted_at": "2024-01-15T09:30:00Z",
          "lifetime_file_limit": 1,
          "member_limit": 1,
          "name": "string",
          "payment_method": "stripe",
          "period": "monthly",
          "project_limit": 1,
          "storage_limit": 1,
          "team_limit": 1,
          "tier": "free",
          "title": "string",
          "updated_at": "2024-01-15T09:30:00Z",
          "user_limit": 1,
          "user_max": 1,
          "version": 1
        },
        "plan_id": "string",
        "promotion_expires_at": "2024-01-15T09:30:00Z",
        "promotion_id": "string",
        "requires_autoscaling": true,
        "storage_limit": 1,
        "subscription_end_at": "2024-01-15T09:30:00Z",
        "total_archived_storage_limit": 1,
        "total_lifetime_file_limit": 1,
        "total_member_limit": 1,
        "total_project_limit": 1,
        "total_storage_limit": 1,
        "total_user_limit": 1,
        "updated_at": "2024-01-15T09:30:00Z",
        "user_limit": 1
      },
      "account_members": [
        {
          "accepted_at": "2024-01-15T09:30:00Z",
          "account_id": "string",
          "declined_at": "2024-01-15T09:30:00Z",
          "deleted_at": "2024-01-15T09:30:00Z",
          "inserted_at": "2024-01-15T09:30:00Z",
          "role": "admin",
          "updated_at": "2024-01-15T09:30:00Z",
          "user_id": "string"
        }
      ],
      "frames": 1,
      "member_count": 1,
      "image_256": "string"
    },
    "image_32": "string",
    "inserted_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "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": "string",
    "session_watermark_templates": [
      {
        "account_id": "string",
        "app_default": false,
        "creator_id": "string",
        "id": "string",
        "name": "string",
        "watermark_blocks": [
          {
            "alpha": 0.5,
            "data_points": [
              {
                "order": 1,
                "type": "email",
                "value": "string"
              }
            ],
            "font_size": "medium",
            "name": "string",
            "position": "top_left",
            "position_reference_point": "top_left",
            "position_x": 1,
            "position_y": 1,
            "scroll_text": "none",
            "text_alignment": "left",
            "text_color": "#FFFFFF",
            "text_shadow": false
          }
        ]
      }
    ],
    "id": "string",
    "member_limit": 1,
    "frames": 0,
    "member_count": 0,
    "image_256": "string",
    "background_color": "string"
  },
  "team_id": "string",
  "updated_at": "2024-01-15T09:30:00Z",
  "url": "string"
}

Update the settings for a given Webhook via its ID

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

hook_idstringRequiredformat: "uuid"

Webhook ID

Request

Webhook to create or update

namestringRequired

Name of the Webhook

urlstringRequired

HTTPS endpoint to delivery events to

eventslist of stringsOptional

Response

Webhook success response

account_idstringOptionalformat: "uuid"

activebooleanOptional

app_idstringOptionalformat: "uuid"

deleted_atstringOptionalformat: "date-time"

eventslist of enumsOptional

idstringOptionalformat: "uuid"

inserted_atstringOptionalformat: "date-time"

namestringOptional

project_idstringOptionalformat: "uuid"

secretstringOptional

teamobjectOptional

team_idstringOptionalformat: "uuid"

updated_atstringOptionalformat: "date-time"

urlstringOptional

Errors

401

Unauthorized Error

404

Not Found Error