Auth0 Authentication API Webhooks

The Auth0 Authentication API Webhooks Extension is a scheduled job that allows you to use your own custom webhooks in conjunction with the Auth0 Authentication API. The extension will go through the audit logs and call the appropriate webhook if specific event(s) occur.

Configuring the Extension

To complete installation of this extension, click on the Auth0 Authentication API Webhooks box in the list of provided extensions on the Extensions page of the Management Portal. In the "Install Extension" window that then pops open, you will be asked to provide the following configuration variables:

  • Schedule: The frequency with which the job runs
  • Auth0_Domain: The domain of your Auth0 app
  • Auth0_Global_Client_ID: The Client ID of your Auth0 app
  • Auth0_Global_Client_Secret: The Client Secret of your Auth0 app
  • Auth0_API_Endpoints: The specific Auth0 Management API endpoints you want to monitor/call
  • Webhook URL: The URL of your webhook
  • Webhook_Concurrent_Calls: The maximum number of concurrent calls that will be made to your webhook
  • Log_Level: The minimal log level of events that you would like sent
  • Log_Types: The specific events for which logs should be exported

Once you have provided the required pieces of information, click "Install" to finish installing the extension.

Using Your Installed Extension

You can view all scheduled jobs by clicking on the Auth0 Management API Webhooks line under the "Installed Extensions" tab.

Sample Payload

Here is an example of the payload that will be sent:

  date: '2016-02-25T13:42:08.791Z',
  type: 'f',
  description: 'Wrong email or password.',
  connection: 'My-Users',
  client_id: 'lIkP1Wn4qQPj56k9bE7fyMrbsaaHXd6c',
  client_name: 'Default App',
  ip: '',
  user_agent: 'Chrome 48.0.2564 / Mac OS X 10.11.3',
   { error:
      { message: 'Wrong email or password.',
        oauthError: 'Wrong email or password.',
        type: 'invalid_user_password' },
      { client_id: 'lIkP1Wn4qQPj56k9bE7fyMrbsaaHXd6c',
        username: '',
        password: '*****',
        connection: 'My-Users'',
        grant_type: 'password',
        scope: 'openid',
        device: '' },
     qs: {},
     connection: 'My-Users' },
  user_id: '',
  user_name: 'Default App',
  strategy: 'auth0',
  strategy_type: 'database',
  _id: '49556539073893675610923042044589174982043486779166687234',
  isMobile: false