{
  "opencollection": "1.0.0",
  "info": {
    "name": "Auth0 Authentication actions hooks API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "hooks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Hooks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/hooks",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page index of the results to return. First page is 0."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page."
              },
              {
                "name": "include_totals",
                "value": "",
                "type": "query",
                "description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
              },
              {
                "name": "enabled",
                "value": "",
                "type": "query",
                "description": "Optional filter on whether a hook is enabled (true) or disabled (false)."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to include in the result. Leave empty to retrieve all fields."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "Retrieves hooks that match the trigger"
              }
            ]
          },
          "docs": "Retrieve all <a href=\"https://auth0.com/docs/hooks\">hooks</a>. Accepts a list of fields to include or exclude in the result.\n"
        },
        {
          "info": {
            "name": "Create a Hook",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/hooks",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new hook.\n"
        },
        {
          "info": {
            "name": "Get a Hook",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/hooks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the hook to retrieve."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to include in the result. Leave empty to retrieve all fields."
              }
            ]
          },
          "docs": "Retrieve <a href=\"https://auth0.com/docs/hooks\">a hook</a> by its ID. Accepts a list of fields to include in the result.\n"
        },
        {
          "info": {
            "name": "Update a Hook",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/hooks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the hook to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing hook.\n"
        },
        {
          "info": {
            "name": "Delete a Hook",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{auth0_domain}/hooks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the hook to delete."
              }
            ]
          },
          "docs": "Delete a hook.\n"
        },
        {
          "info": {
            "name": "Get Hook Secrets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/hooks/:id/secrets",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the hook to retrieve secrets from."
              }
            ]
          },
          "docs": "Retrieve a hook's secrets by the ID of the hook. \n"
        },
        {
          "info": {
            "name": "Add Hook Secrets",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/hooks/:id/secrets",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the hook to retrieve"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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. \n"
        },
        {
          "info": {
            "name": "Update Hook Secrets",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/hooks/:id/secrets",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the hook whose secrets to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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. \n"
        },
        {
          "info": {
            "name": "Delete Hook Secrets",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{auth0_domain}/hooks/:id/secrets",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the hook whose secrets to delete."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete. "
        }
      ]
    }
  ],
  "bundled": true
}