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.
okta.eventHooks.read
Lists all event hooks
Success
Forbidden
Too Many Requests
[- {
- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.eventHooks.manage
Creates an event hook
Success
Bad Request
Forbidden
Too Many Requests
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.eventHooks.read
Retrieves an event hook
Success
Forbidden
Not Found
Too Many Requests
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.eventHooks.manage
Replaces an event hook
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED"
}
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.eventHooks.manage
Deletes an event hook
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.eventHooks.manage
Activates an event hook
Success
Forbidden
Not Found
Too Many Requests
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.eventHooks.manage
Deactivates an event hook
Success
Forbidden
Not Found
Too Many Requests
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.eventHooks.manage
Verifies an event hook
Success
Forbidden
Not Found
Too Many Requests
{- "channel": {
- "config": {
- "authScheme": {
- "key": "string",
- "type": "HEADER",
- "value": "string"
}, - "headers": [
- {
- "key": "string",
- "value": "string"
}
], - "uri": "string"
}, - "type": "HTTP",
- "version": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "events": {
- "items": [
- "string"
], - "type": "EVENT_TYPE"
}, - "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "verificationStatus": "UNVERIFIED",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}