Event Hooks

The Event Hooks API provides operations to manage event hooks for your organization.

For general information on event hooks and how to create and use them, see Event hooks. The following documentation is only for the management API, which provides a CRUD interface for registering event hooks.

For a step-by-step guide on implementing an example event hook, see the Event hook guide.

List all Event Hooks
OAuth 2.0: okta.eventHooks.read

Lists all event hooks

Responses
200

Success

403

Forbidden

429

Too Many Requests

get/api/v1/eventHooks
Request samples 
Response samples 
application/json
[
  • {
    • "channel": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "createdBy": "string",
    • "events": {
      },
    • "id": "string",
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "status": "ACTIVE",
    • "verificationStatus": "UNVERIFIED",
    • "_links": {
      }
    }
]
Create an Event Hook
OAuth 2.0: okta.eventHooks.manage
Creates an event hook


Request 
Request Body schema: application/json
object (EventHookChannel) 
 
object (EventHookChannelConfig) 
 
object (EventHookChannelConfigAuthScheme) 
 
Array of objects (EventHookChannelConfigHeader) 
 
uri
string
 
type
string (EventHookChannelType) 
 Value: "HTTP"  
version
string
 
createdBy
string
 
object (EventSubscriptions) 
 
name
string
 
status
string (LifecycleStatus) 
 Enum: "ACTIVE" "INACTIVE"  
verificationStatus
string (EventHookVerificationStatus) 
 Enum: "UNVERIFIED" "VERIFIED"  
Responses 
200
Success


400
Bad Request


403
Forbidden


429
Too Many Requests


post/api/v1/eventHooks
Request samples 
application/json
{
  • "channel": {
    • "config": {
      },
    • "type": "HTTP",
    • "version": "string"
    },
  • "createdBy": "string",
  • "events": {
    • "items": [
      ],
    • "type": "EVENT_TYPE"
    },
  • "name": "string",
  • "status": "ACTIVE",
  • "verificationStatus": "UNVERIFIED"
}
Response samples 
application/json
{
  • "channel": {
    • "config": {
      },
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "events": {
    • "items": [
      ],
    • "type": "EVENT_TYPE"
    },
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "verificationStatus": "UNVERIFIED",
  • "_links": {
    • "self": {
      }
    }
}
Retrieve an Event Hook
OAuth 2.0: okta.eventHooks.read
Retrieves an event hook


Request 
path Parameters
eventHookId
required
string
id of the Event Hook


 
 Example:  YTDQbItFfFuy9RdHrvly
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/eventHooks/{eventHookId}
Request samples 
Response samples 
application/json
{
  • "channel": {
    • "config": {
      },
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "events": {
    • "items": [
      ],
    • "type": "EVENT_TYPE"
    },
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "verificationStatus": "UNVERIFIED",
  • "_links": {
    • "self": {
      }
    }
}
Replace an Event Hook
OAuth 2.0: okta.eventHooks.manage
Replaces an event hook


Request 
path Parameters
eventHookId
required
string
id of the Event Hook


 
 Example:  YTDQbItFfFuy9RdHrvly
Request Body schema: application/json
object (EventHookChannel) 
 
object (EventHookChannelConfig) 
 
object (EventHookChannelConfigAuthScheme) 
 
Array of objects (EventHookChannelConfigHeader) 
 
uri
string
 
type
string (EventHookChannelType) 
 Value: "HTTP"  
version
string
 
createdBy
string
 
object (EventSubscriptions) 
 
name
string
 
status
string (LifecycleStatus) 
 Enum: "ACTIVE" "INACTIVE"  
verificationStatus
string (EventHookVerificationStatus) 
 Enum: "UNVERIFIED" "VERIFIED"  
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/eventHooks/{eventHookId}
Request samples 
application/json
{
  • "channel": {
    • "config": {
      },
    • "type": "HTTP",
    • "version": "string"
    },
  • "createdBy": "string",
  • "events": {
    • "items": [
      ],
    • "type": "EVENT_TYPE"
    },
  • "name": "string",
  • "status": "ACTIVE",
  • "verificationStatus": "UNVERIFIED"
}
Response samples 
application/json
{
  • "channel": {
    • "config": {
      },
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "events": {
    • "items": [
      ],
    • "type": "EVENT_TYPE"
    },
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "verificationStatus": "UNVERIFIED",
  • "_links": {
    • "self": {
      }
    }
}
Delete an Event Hook
OAuth 2.0: okta.eventHooks.manage
Deletes an event hook


Request 
path Parameters
eventHookId
required
string
id of the Event Hook


 
 Example:  YTDQbItFfFuy9RdHrvly
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/eventHooks/{eventHookId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}
Activate an Event Hook
OAuth 2.0: okta.eventHooks.manage
Activates an event hook


Request 
path Parameters
eventHookId
required
string
id of the Event Hook


 
 Example:  YTDQbItFfFuy9RdHrvly
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/eventHooks/{eventHookId}/lifecycle/activate
Request samples 
Response samples 
application/json
{
  • "channel": {
    • "config": {
      },
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "events": {
    • "items": [
      ],
    • "type": "EVENT_TYPE"
    },
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "verificationStatus": "UNVERIFIED",
  • "_links": {
    • "self": {
      }
    }
}
Deactivate an Event Hook
OAuth 2.0: okta.eventHooks.manage
Deactivates an event hook


Request 
path Parameters
eventHookId
required
string
id of the Event Hook


 
 Example:  YTDQbItFfFuy9RdHrvly
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/eventHooks/{eventHookId}/lifecycle/deactivate
Request samples 
Response samples 
application/json
{
  • "channel": {
    • "config": {
      },
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "events": {
    • "items": [
      ],
    • "type": "EVENT_TYPE"
    },
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "verificationStatus": "UNVERIFIED",
  • "_links": {
    • "self": {
      }
    }
}
Verify an Event Hook
OAuth 2.0: okta.eventHooks.manage
Verifies an event hook


Request 
path Parameters
eventHookId
required
string
id of the Event Hook


 
 Example:  YTDQbItFfFuy9RdHrvly
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/eventHooks/{eventHookId}/lifecycle/verify
Request samples 
Response samples 
application/json
{
  • "channel": {
    • "config": {
      },
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "events": {
    • "items": [
      ],
    • "type": "EVENT_TYPE"
    },
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "verificationStatus": "UNVERIFIED",
  • "_links": {
    • "self": {
      }
    }
}