Manage Applications

    Update webhook

    put
    https://api.box.com/2.0
    /webhooks/:webhook_id

    Updates a webhook.

    Request

    application/json

    Path Parameters

    stringin pathrequired
    3321123

    The ID of the webhook.

    Request Body

    stringin bodyoptional
    https://example.com/webhooks

    The URL that is notified by this webhook

    objectin body

    The item that will trigger the webhook

    stringin bodyoptional
    1231232

    The ID of the item to trigger a webhook

    stringin bodyoptional
    file

    The type of item to trigger a webhook

    Value is one of "file", "folder"

    string arrayin bodyoptional
    ["FILE.UPLOADED"]

    An array of event names that this webhook is to be triggered for

    Value is any of "FILE.UPLOADED", "FILE.PREVIEWED", "FILE.DOWNLOADED", "FILE.TRASHED", "FILE.DELETED", "FILE.RESTORED", "FILE.COPIED", "FILE.MOVED", "FILE.LOCKED", "FILE.UNLOCKED", "FILE.RENAMED", "COMMENT.CREATED", "COMMENT.UPDATED", "COMMENT.DELETED", "TASK_ASSIGNMENT.CREATED", "TASK_ASSIGNMENT.UPDATED", "METADATA_INSTANCE.CREATED", "METADATA_INSTANCE.UPDATED", "METADATA_INSTANCE.DELETED", "FOLDER.CREATED", "FOLDER.RENAMED", "FOLDER.DOWNLOADED", "FOLDER.RESTORED", "FOLDER.DELETED", "FOLDER.COPIED", "FOLDER.MOVED", "FOLDER.TRASHED", "WEBHOOK.DELETED", "COLLABORATION.CREATED", "COLLABORATION.ACCEPTED", "COLLABORATION.REJECTED", "COLLABORATION.REMOVED", "COLLABORATION.UPDATED", "SHARED_LINK.DELETED", "SHARED_LINK.CREATED", "SHARED_LINK.UPDATED"

    Response

    application/jsonWebhook

    Returns the new webhook object.

    application/jsonClient Error

    Returns an error if the parameters were incorrect.

    application/jsonClient Error

    Returns an error if the application does not have the permission to manage webhooks.

    application/jsonClient Error

    Returns an error if the target item or webhook could not be found

    application/jsonClient Error

    Returns an error if the a webhook for this combination of target, application, and user already exists.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X PUT https://api.box.com/2.0/webhooks/3321123 \
         -H "Authorization: Bearer <ACCESS_TOKEN>" \
         -H "Content-Type: application/json" \
         -d '{
           "triggers": [
             "FILE.DOWNLOADED"
           ]
         }'
    .NET
    var updates = new BoxWebhookRequest()
    {
        Id = "12345",
        Address = "https://example.com/webhooks/fileActions
    };
    BoxWebhook updatedWebhook = await client.WebhooksManager.UpdateWebhookAsync(updates);
    Java
    BoxWebHook webhook = new BoxWebHook(api, id);
    BoxWebHook.Info info = webhook.getInfo();
    info.addPendingChange("address", url);
    webhook.update(info);
    Python
    update_object = {
        'triggers': ['FILE.COPIED'],
        'address': 'https://newexample.com',
    }
    webhook = client.webhook(webhook_id='12345').update_info(update_object)
    print('Updated the webhook info for triggers: {0} and address: {1}'.format(webhook.triggers, webhook.address))
    Node
    client.webhooks.update('678901', {address: "https://example.com/webhooks/fileActions"})
    	.then(webhook => {
    		/* webhook -> {
    			id: '1234',
    			type: 'webhook',
    			target: { id: '22222', type: 'folder' },
    			created_by: 
    			{ type: 'user',
    				id: '33333',
    				name: 'Example User',
    				login: 'user@example.com' },
    			created_at: '2016-05-09T17:41:27-07:00',
    			address: 'https://example.com/webhooks/fileActions',
    			triggers: [ 'FILE.DOWNLOADED', 'FILE.UPLOADED' ] }
    		*/
    	});

    Response Example

    {
      "id": 11446498,
      "type": "webhook",
      "target": {
        "id": 1231232,
        "type": "file"
      },
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "address": "https://example.com/webhooks",
      "triggers": [
        "FILE.UPLOADED"
      ]
    }