Get a hook

Retrieve a hook by its ID. Accepts a list of fields to include in the result.

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Hooks.GetAsync(
            id: "id",
            request: new GetHookRequestParameters {
                Fields = "fields"
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.GetHookRequestParameters{
        Fields: management.String(
            "fields",
        ),
    }
    mgmt.Hooks.Get(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.GetHookRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.hooks().get(
            "id",
            GetHookRequestParameters
                .builder()
                .fields("fields")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Hooks\Requests\GetHookRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->hooks->get(
    'id',
    new GetHookRequestParameters([
        'fields' => 'fields',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.hooks.get(
    id="id",
    fields="fields",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.hooks.get(
  id: "id",
  fields: "fields"
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request GET \
  --url https://{tenantDomain}/api/v2/hooks/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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 retrieve.

Query Parameters

fields · string

Comma-separated list of fields to include in the result. Leave empty to retrieve all fields.

Response

200

application/json

Hook successfully retrieved.

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