Create a hook

Create a new hook.

POST https://{tenantDomain}/api/v2/hooks

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.CreateHookRequestContent{
        Name: "name",
        Script: "script",
        TriggerId: management.HookTriggerIdEnumCredentialsExchange,
    }
    client.Hooks.Create(
        context.TODO(),
        request,
    )
}

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.

Body

application/jsonapplication/x-www-form-urlencoded

name · string · default: my-hook · required

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); }; · required

Code to be executed when this hook runs.

Minimum string length: 1

triggerId · enum<string> · required

Execution stage of this rule. Can be credentials-exchange, pre-user-registration, post-user-registration, post-change-password, or send-phone-message.

Available options: credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message

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