Socotra Event API
The Event API from Socotra — 18 operation(s) for event.
OpenAPI Specification
openapi: 3.0.1
info:
title: Socotra Insurance Suite OpenAPI Definition Event API
description: Socotra Insurance Suite API
termsOfService: https://www.socotra.com
version: v0
servers:
- url: /
description: Generated server url
tags:
- name: Event
paths:
/event/{tenantLocator}/webhooks:
post:
operationId: createWebhook
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWebhookRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookResponse'
deprecated: false
x-securityGroup: webhooks
x-securityPermission:
- write
deprecated: false
tags:
- Event
/event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}/resend:
post:
operationId: resendDivertedEvent
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: webhookLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: eventLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
deprecated: false
x-securityGroup: diverted-events
x-securityPermission:
- resend
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/schedules/failed/resume:
post:
operationId: resumeFailedScheduledEvent
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FailedJobRequest'
deprecated: false
required: true
responses:
'204':
description: No Content
x-securityGroup: events
x-securityPermission:
- write
deprecated: false
tags:
- Event
/event/{tenantLocator}/webhooks/{webhookLocator}:
get:
operationId: fetchWebhook
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: webhookLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookResponse'
deprecated: false
x-securityGroup: webhooks
x-securityPermission:
- read
deprecated: false
tags:
- Event
patch:
operationId: updateWebhook
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: webhookLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWebhookRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookResponse'
deprecated: false
x-securityGroup: webhooks
x-securityPermission:
- write
deprecated: false
tags:
- Event
delete:
operationId: deleteWebhook
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: webhookLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'204':
description: No Content
x-securityGroup: webhooks
x-securityPermission:
- write
deprecated: false
tags:
- Event
/event/{tenantLocator}/webhooks/{webhookLocator}/unsuspend:
patch:
operationId: unsuspendWebhook
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: webhookLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'204':
description: No Content
x-securityGroup: webhooks
x-securityPermission:
- write
deprecated: false
tags:
- Event
/event/{tenantLocator}/webhooks/{webhookLocator}/diverted:
get:
operationId: fetchMultipleDivertedEvents
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: webhookLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/DivertedEventResponse'
deprecated: false
x-securityGroup: diverted-events
x-securityPermission:
- read
- list
deprecated: false
tags:
- Event
/event/{tenantLocator}/webhooks/{webhookLocator}/diverted/{eventLocator}:
get:
operationId: fetchDivertedEvent
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: webhookLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: eventLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DivertedEventResponse'
deprecated: false
x-securityGroup: diverted-events
x-securityPermission:
- read
deprecated: false
tags:
- Event
delete:
operationId: deleteDivertedEvent
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: webhookLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: eventLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
deprecated: false
x-securityGroup: diverted-events
x-securityPermission:
- delete
deprecated: false
tags:
- Event
/event/{tenantLocator}/webhooks/list:
get:
operationId: fetchWebhooks
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: name
in: query
required: false
schema:
type: string
deprecated: false
- name: enabled
in: query
required: false
schema:
type: boolean
deprecated: false
- name: suspended
in: query
required: false
schema:
type: boolean
deprecated: false
- name: active
in: query
required: false
schema:
type: boolean
deprecated: false
- name: eventTypes
in: query
required: false
schema:
type: array
deprecated: false
items:
type: string
deprecated: false
- name: extended
in: query
required: false
schema:
type: boolean
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookListResponse'
deprecated: false
x-securityGroup: webhooks
x-securityPermission:
- read
- list
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/{locator}:
get:
operationId: fetchEvent
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EventResponse'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/schedules/tenant:
get:
operationId: fetchScheduledTenantEvents
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/ScheduledTenantEvent'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/schedules/tenant/failed/list:
get:
operationId: fetchFailedScheduledTenantEvents
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/FailedJobDetails'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/schedules/policy/{policyLocator}:
get:
operationId: fetchScheduledPolicyEvents
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: policyLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/ScheduledPolicyEvent'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/schedules/policy/{policyLocator}/failed/list:
get:
operationId: fetchFailedScheduledPolicyEvents
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: policyLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/FailedJobDetails'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/schedules/failed/{failedJobState}/list:
get:
operationId: fetchFailedScheduledEventsByFailedJobState
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: failedJobState
in: path
required: true
schema:
type: string
enum:
- queued
- quit
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/FailedJobDetails'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/schedules/failed/list:
get:
operationId: fetchFailedScheduledEvents
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/FailedJobDetails'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/request/{locator}:
get:
operationId: fetchEventsForARequest
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/EventResponse'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/list:
get:
operationId: fetchMultipleEvents
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: startTimestamp
in: query
required: false
schema:
type: string
format: date-time
deprecated: false
- name: endTimestamp
in: query
required: false
schema:
type: string
format: date-time
deprecated: false
- name: type
in: query
required: false
schema:
type: string
deprecated: false
- name: pageSize
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: pagingToken
in: query
required: false
schema:
type: string
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EventStreamResponse'
deprecated: false
x-securityGroup: events
x-securityPermission:
- read
- list
deprecated: false
tags:
- Event
/event/{tenantLocator}/events/schedules/failed:
delete:
operationId: deleteFailedScheduledEvent
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FailedJobRequest'
deprecated: false
required: true
responses:
'204':
description: No Content
x-securityGroup: events
x-securityPermission:
- write
deprecated: false
tags:
- Event
components:
schemas:
EndpointResponse:
type: object
required:
- hmacEnabled
- secret
- secureSsl
- tag
- url
- headers
properties:
url:
type: string
deprecated: false
headers:
type: object
deprecated: false
additionalProperties:
type: array
deprecated: false
items:
type: string
deprecated: false
secureSsl:
type: boolean
deprecated: false
hmacEnabled:
type: boolean
deprecated: false
secret:
type: string
deprecated: false
tag:
type: string
deprecated: false
deprecated: false
WebhookListResponse:
type: object
required:
- listCompleted
- items
properties:
listCompleted:
type: boolean
deprecated: false
items:
type: array
deprecated: false
items:
$ref: '#/components/schemas/WebhookResponse'
deprecated: false
deprecated: false
CreateEndpointRequest:
type: object
required:
- url
properties:
url:
type: string
deprecated: false
headers:
type: object
deprecated: false
additionalProperties:
type: array
deprecated: false
items:
type: string
deprecated: false
secureSsl:
type: boolean
deprecated: false
hmacEnabled:
type: boolean
deprecated: false
secret:
type: string
deprecated: false
tag:
type: string
deprecated: false
deprecated: false
UpdateEndpointRequest:
type: object
required:
- url
- addHeaders
- removeHeaders
properties:
url:
type: string
deprecated: false
removeHeaders:
type: array
deprecated: false
items:
type: string
deprecated: false
addHeaders:
type: object
deprecated: false
additionalProperties:
type: array
deprecated: false
items:
type: string
deprecated: false
secureSsl:
type: boolean
deprecated: false
hmacEnabled:
type: boolean
deprecated: false
secret:
type: string
deprecated: false
tag:
type: string
deprecated: false
deprecated: false
RetryStrategyUpdateRequest:
type: object
required:
- attempts
- interval
- type
properties:
type:
type: string
enum:
- linear
- exponential
deprecated: false
interval:
type: integer
format: int64
deprecated: false
attempts:
type: integer
format: int32
deprecated: false
deprecated: false
FailureHandlingCreateRequest:
type: object
required:
- alertEndpoint
- divert
- retryStrategy
- suspend
- triggers
properties:
alertEndpoint:
$ref: '#/components/schemas/CreateEndpointRequest'
deprecated: false
triggers:
type: array
deprecated: false
items:
type: string
deprecated: false
retryStrategy:
$ref: '#/components/schemas/RetryStrategyCreateRequest'
deprecated: false
divert:
type: boolean
deprecated: false
suspend:
type: boolean
deprecated: false
deprecated: false
FailureHandlingUpdateRequest:
type: object
required:
- alertEndpoint
- divert
- removeAlertEndpoint
- removeRetryStrategy
- retryStrategy
- suspend
- addTriggers
- removeTriggers
properties:
removeAlertEndpoint:
type: boolean
deprecated: false
alertEndpoint:
$ref: '#/components/schemas/UpdateEndpointRequest'
deprecated: false
removeTriggers:
type: array
deprecated: false
items:
type: string
deprecated: false
addTriggers:
type: array
deprecated: false
items:
type: string
deprecated: false
removeRetryStrategy:
type: boolean
deprecated: false
retryStrategy:
$ref: '#/components/schemas/RetryStrategyUpdateRequest'
deprecated: false
divert:
type: boolean
deprecated: false
suspend:
type: boolean
deprecated: false
deprecated: false
RetryStrategyResponse:
type: object
required:
- attempts
- interval
- type
properties:
type:
type: string
enum:
- linear
- exponential
deprecated: false
interval:
type: integer
format: int64
deprecated: false
attempts:
type: integer
format: int32
deprecated: false
deprecated: false
WebhookResponse:
type: object
required:
- locator
- name
- enabled
- endpoint
- failureHandling
- suspended
- suspendedAt
- eventTypes
properties:
locator:
type: string
format: ulid
deprecated: false
name:
type: string
deprecated: false
enabled:
type: boolean
deprecated: false
suspended:
type: boolean
deprecated: false
suspendedAt:
type: string
format: date-time
deprecated: false
eventTypes:
type: array
deprecated: false
items:
type: string
deprecated: false
endpoint:
$ref: '#/components/schemas/EndpointResponse'
deprecated: false
failureHandling:
$ref: '#/components/schemas/FailureHandlingResponse'
deprecated: false
deprecated: false
RetryStrategyCreateRequest:
type: object
required:
- attempts
- interval
- type
properties:
type:
type: string
enum:
- linear
- exponential
deprecated: false
interval:
type: integer
format: int64
deprecated: false
attempts:
type: integer
format: int32
deprecated: false
deprecated: false
DivertedEventResponse:
type: object
required:
- eventLocator
- requestLocator
- failureMessage
- failureTimestamp
- failureTrigger
properties:
requestLocator:
type: string
format: ulid
deprecated: false
eventLocator:
type: string
format: ulid
deprecated: false
failureTrigger:
type: string
deprecated: false
failureMessage:
type: string
deprecated: false
failureTimestamp:
type: string
format: date-time
deprecated: false
deprecated: false
EventResponse:
type: object
required:
- locator
- userLocator
- requestId
- timestamp
- type
- data
properties:
locator:
type: string
format: ulid
deprecated: false
requestId:
type: string
format: ulid
description: Identifier of the transaction request that triggered the event
deprecated: false
userLocator:
type: string
format: uuid
deprecated: false
timestamp:
type: string
format: date-time
deprecated: false
type:
type: string
deprecated: false
data:
type: object
deprecated: false
additionalProperties:
type: object
deprecated: false
deprecated: false
UpdateWebhookRequest:
type: object
required:
- name
- enabled
- endpoint
- failureHandling
- removeFailureHandling
- addEventTypes
- removeEventTypes
properties:
name:
type: string
deprecated: false
enabled:
type: boolean
deprecated: false
removeEventTypes:
type: array
deprecated: false
items:
type: string
deprecated: false
addEventTypes:
type: array
deprecated: false
items:
type: string
deprecated: false
endpoint:
$ref: '#/components/schemas/UpdateEndpointRequest'
deprecated: false
removeFailureHandling:
type: boolean
deprecated: false
failureHandling:
$ref: '#/components/schemas/FailureHandlingUpdateRequest'
deprecated: false
deprecated: false
FailedJobRequest:
type: object
required:
- triggerName
- triggerGroup
properties:
triggerGroup:
type: string
deprecated: false
triggerName:
type: string
deprecated: false
deprecated: false
FailureHandlingResponse:
type: object
required:
- alertEndpoint
- divert
- retryStrategy
- suspend
- triggers
properties:
alertEndpoint:
$ref: '#/components/schemas/EndpointResponse'
deprecated: false
triggers:
type: array
deprecated: false
items:
type: string
deprecated: false
retryStrategy:
$ref: '#/components/schemas/RetryStrategyResponse'
deprecated: false
divert:
type: boolean
deprecated: false
suspend:
type: boolean
deprecated: false
deprecated: false
EventStreamResponse:
type: object
required:
- pagingToken
- events
properties:
pagingToken:
type: string
deprecated: false
events:
type: array
deprecated: false
items:
$ref: '#/components/schemas/EventResponse'
deprecated: false
deprecated: false
CreateWebhookRequest:
type: object
required:
- name
- enabled
- endpoint
- failureHandling
- eventTypes
properties:
name:
type: string
deprecated: false
enabled:
type: boolean
deprecated: false
eventTypes:
type: array
deprecated: false
items:
type: string
deprecated: false
endpoint:
$ref: '#/components/schemas/CreateEndpointRequest'
deprecated: false
failureHandling:
$ref: '#/components/schemas/FailureHandlingCreateRequest'
deprecated: false
useAutomationPlugin:
type: boolean
deprecated: false
deprecated: false
ScheduledTenantEvent:
type: object
required:
- triggerState
- customEventId
- scheduledEventId
properties:
scheduledEventId:
type: string
deprecated: false
customEventId:
type: string
deprecated: false
nextEventTime:
type: string
format: date-time
deprecated: false
triggerState:
type: string
enum:
- NONE
- NORMAL
- PAUSED
- COMPLETE
- ERROR
- BLOCKED
deprecated: false
deprecated: false
ScheduledPolicyEvent:
type: object
required:
- policyLocator
- transactionLocator
- triggerState
- customEventId
properties:
policyLocator:
type: string
format: ulid
deprecated: fal
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-event-api-openapi.yml