Couchdrop Developer Docs
Couchdrop HomepageKnowledge BaseLogin
  • Couchdrop API Overview
  • Available Endpoints
  • Errors and Response Codes
  • Domains and Accounts
    • Register a new domain
    • Manage domain/account
    • Authentication
  • Administration
    • Users
    • Groups
    • Folder Permissions
    • Folder Properties
    • Shared Links
    • Storage Connections
      • SFTP Connections
      • S3 Connections
      • FTP Connections
      • Azure Connections
      • GCS Connections
      • Other
    • Automations
      • Scheduled Automations
        • Create/Update
        • Get all schedule workflows
        • Get schedule workflow
        • Trigger schedule workflow
        • Delete Scheduled Workflow
      • Event Automations
        • Create/Update
        • Get action workflow
        • Get all action workflows
        • Delete Action Workflow
      • Actions
        • Webhook
        • Rename
        • Copy
        • Move
        • PGP Encrypt
        • Paths
      • Conditions
    • Symlinks/Shortcuts
    • Auditing and Reporting
  • Webhooks
    • Using webhooks
  • Filesystem Operations
    • Listing files/folders
    • Downloading a file
    • Uploading a File
    • Rename files/folders
    • Deleting files/folders
    • Create a folder
Powered by GitBook

Couchdrop

  • Couchdrop Homepage
  • Register
  • Login

Platform

  • Cloud SFTP Server
  • Cloud FTP Server
  • Automated Transfers
  • Mailboxes and Inboxes

Copyright Couchdrop Limited 2025

On this page

Was this helpful?

  1. Webhooks

Using webhooks

Couchdrop provides configurable webhooks on all file events. Webhooks can be sent to a HTTPS endpoint and always contain a JSON body with the event details.

An example event body

Fields included in the body are variable and additional fields will be added over time, below is an example of a upload or download event

{
"account":"devaccount1",
"filename":"/storage/testfile.txt",
"authenticated_user":"user1",
"event_type":"upload",
"ip_address":"8.8.4.4",
"success": true,
"total_size":173331,
"additional_info":"",
            
"system":"sftp",
"transaction_id":"<randomuuid>",
}

Get in touch with support for more information or to request particular fields be added to the webhooks

PreviousAuditing and ReportingNextListing files/folders

Last updated 3 years ago

Was this helpful?