Webhooks

Webhooks allow you to receive notifications at an end-point of your choice for a myriad of events in Image Relay. Get notified when a file is uploaded, a new user is added, a folder is deleted, etc.

When there is a problem with a webhook, Image Relay will send an email to the user that created the webhook. The API also supports optionally adding additional notification emails to the webhook if you wish to alert other email addresses if issues arise.

Details about our currently supported list of resources and actions:

Response

All Webhook POSTs will contain an event section which then has a resource, action, resource_id, actor_id, and potentially recipient_id. resource is the type of resource triggering the event (e.g. file, folder...), action is the type of action that occurred (e.g. created, updated...), resource_id is the unique ID in Image Relay for the resource that triggered this event. actor_id is the unique ID of the user who caused the event to happen (i.e. uploaded the file,
created the folder), and recipient_id is optionally present when necessary. For instance, in the case of a "File added to
Folder" triggered, recipient_id would be the unique folder ID of the folder to which the file was added. The event section will always be present for all webhook calls.

A data section is also included containing data specific to the resource being triggered. For a File, for instance, it will contain details
about the file such as name, ID, parent folder, etc.

Resource: File

• Created: triggered when a file is created at Image Relay
• Deleted: triggered when a file is deleted from Image Relay
• Processed: triggered when a file has been created or updated in Image Relay and is available for download
• Expiration Date Set: triggered when a user sets an expiration date on a file (NOT when the file expires)
• Expiration Date Removed: triggered when a user removes an expiration date from a file (NOT when the file expires)
• File Type Changed: triggered when a user changes the File Type of a file
• Keywords/Tags Updated: triggered when a file's tags are updated
• Name Changed: triggered when a user changes the name of a file
• Recovered: triggered when a file is recovered from the trash
• Added To Folder: triggered when a file is added to a folder
• Removed from Folder: triggered when a file is removed from a folder
• File Updated: triggered when the original file is updated in Image Relay

Sample Data

JSON

{
  "event": {
    "resource":"file",
    "action":"<file_action>",
    "resource_id":"<file_id>",
    "actor_id":"user_id>",
    "recipient_id":"<potential_folder_id>"
  },
  "data": {
    "id": "<file_id>",
    "content_type": "application/octet-stream",
    "size": "<size>",
    "width": null,
    "height": null,
    "created_at": "<created>",
    "updated_on": "<updated>",
    "deleted": true/false,
    "user_id": "<user_id>",
    "expires_on": null,
    "name": "<filename>",
    "file_type_id": "<file_type_id>",
    "terms": [
      {
        "name": "<term>",
        "value": "",
        "metaterm_id": "<metaterm_id>"
      },
      {...}
    ],
    "folders": ["<folders>"],
    "folder_ids": ["<folder_ids>"],
    "permission_ids": ["<permission_ids"]
  }
}

Resource: Folder

• Created: triggered when a folder is created at Image Relay
• Renamed: triggered when a folder is renamed
• Moved: triggered when a folder is moved
• Deleted: triggered when a folder is deleted
• Recovered: triggered when a folder is recovered
• Shared: triggered when a user shares a public link to a folder

Sample Data

JSON

{
    "event":
    {
        "resource":"folder",
        "action":"<folder_action>",
        "resource_id":"<folder_id>",
        "actor_id":"<user_id>"
    },
    "data":
    {
        "created_on":"<created>",
        "id":"<folder_id>",
        "name":"<folder>",
        "parent_id":"<parent_folder_id>",
        "updated_on":"<updated>",
        "user_id":"<user_id>",
        "full_path":"<path_from_root>",
        "child_count":0,
        "file_count":0,
        "permission_ids":["<permission_ids>"]
    }
}

Resource: User

• Created: triggered when a user is created at Image Relay (not just invited)
• Modified: triggered when a user is modified
• Destroyed: triggered when a user is destroyed

Sample Data

JSON

{
    "event":{
        "resource":"user",
        "action":"<user_action>",
        "resource_id":"new_user_id",
        "actor_id":"<main_user_id>"
    },
    "data":{
        "company":"<new_user_company>",
        "created_on":"<created>"
        ,"custom_field_four":null,
        "custom_field_one":null,
        "custom_field_three":null,
        "custom_field_two":null,
        "email":"<new_user_email>",
        "first_name":"<first_name>",
        "id":"<new_user_id>",
        "last_name":"<last_name>",
        "login":"<login>",
        "updated_on":"<updated>",
        "portal_id":null,
        "permission_id":"<permission_group_id>"
    }
}