Update a hook

Update an existing hook.

PATCH https://{tenantDomain}/api/v2/hooks/{id}

TypeScript

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.update("id", {});
}
main();

201

{
  "triggerId": "<string>",
  "id": "00001",
  "name": "hook",
  "enabled": true,
  "script": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };",
  "dependencies": {}
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the hook to update.

Body

application/jsonapplication/x-www-form-urlencoded

name · string · default: my-hook

Name of this hook.

Pattern: ^[a-zA-Z0-9]([ \-a-zA-Z0-9]*[a-zA-Z0-9])?$

script · string · default: module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };

Code to be executed when this hook runs.

Minimum string length: 1

enabled · boolean · default: false

Whether this hook will be executed (true) or ignored (false).

dependencies · object

Dependencies of this hook used by webtask server.

Show child attributes

Response

201

application/json

Hook successfully created.

triggerId · string

Trigger ID

id · string · default: 00001

ID of this hook.

name · string · default: hook

Name of this hook.

enabled · boolean · default: true

Whether this hook will be executed (true) or ignored (false).

script · string · default: module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };

Code to be executed when this hook runs.

dependencies · object

Dependencies of this hook used by webtask server.

Show child attributes