Auth0 API | Hooks › Get A Hook

Hooks

hooks

Methods

Create A Hook ->

Hook

post/hooks

Create a new hook.

Delete A Hook ->

delete/hooks/{id}

Delete a hook.

Get Hooks -> HooksPageNumberPage<

Hook

get/hooks

Retrieve all hooks. Accepts a list of fields to include or exclude in the result.

Get A Hook ->

Hook

get/hooks/{id}

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

Security

Example: Authorization: Bearer My Bearer Token

Parameters

id: string

fields: string

Optional

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

Response fields

Hook

Request example

curl https://login0.local.dev.auth0.com/api/v2/hooks/$ID \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

{
  "id": "id",
  "dependencies": {
    "foo": "bar"
  },
  "enabled": true,
  "name": "name",
  "script": "script",
  "triggerId": "triggerId"
}

Update A Hook ->

Hook

patch/hooks/{id}

Update an existing hook.

Domain types

Hook = { id, dependencies, enabled, 3 more... }

Hooks

Secrets

hooks.secrets

Methods

Add Hook Secrets ->

post/hooks/{id}/secrets

Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.

Delete Hook Secrets ->

delete/hooks/{id}/secrets

Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.

Get Hook Secrets -> Record<string, unknown>

get/hooks/{id}/secrets

Retrieve a hook's secrets by the ID of the hook.

Update Hook Secrets ->

patch/hooks/{id}/secrets

Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.