Check Webhook Connectivity

curl --request POST \
  --url https://api.explorium.ai/v1/webhooks/check_connectivity \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "partner_id": "<string>",
  "request_context": null,
  "simulation": {
    "event_name": "new_office",
    "number_of_events": 5,
    "event_time": "2023-11-07T05:31:56Z"
  }
}
'

{
  "response_context": {
    "correlation_id": "<string>",
    "request_status": "success",
    "time_took_in_seconds": 123
  }
}

POST

webhooks

check_connectivity

Check Webhook Connectivity

curl --request POST \
  --url https://api.explorium.ai/v1/webhooks/check_connectivity \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "partner_id": "<string>",
  "request_context": null,
  "simulation": {
    "event_name": "new_office",
    "number_of_events": 5,
    "event_time": "2023-11-07T05:31:56Z"
  }
}
'

{
  "response_context": {
    "correlation_id": "<string>",
    "request_status": "success",
    "time_took_in_seconds": 123
  }
}

Authorizations

api_key

string

header

required

Body

application/json

partner_id

string

required

request_context

Request Context · object

Example:

null

simulation

WebhookSimulation · object

Show child attributes

simulation.event_name

enum<string>

The WebhookSimulationEventType class is an enumeration that represents various types of events

Available options:

new_office,

closing_office,

funding_round,

new_investment,

outages_and_security_breaches,

merger_and_acquisitions,

prospect_changed_company,

prospect_job_start_anniversary,

prospect_changed_role

simulation.number_of_events

integer

Number of events to generate in simulation (between 1 and 10)

Required range: 1 <= x <= 10

simulation.event_time

string<date-time>

Response

Successful Response

This is base response model for all responses in partner service.

response_context

ResponseContext · object

required

Show child attributes

response_context.correlation_id

string

required

response_context.request_status

enum<string>

required

The RequestStatus class is an enumeration that defines the possible statuses of a request.

This enum is used to indicate whether a request was successful, missed, or failed. It ensures consistent handling of request statuses across the application.

Attributes: SUCCESS: Indicates that the request was successfully processed. MISS: Indicates that the request did not find any matching data. FAILURE: Indicates that the request encountered an error or failure.

Available options:

success,

miss,

failure

response_context.time_took_in_seconds

number

required

Delete Webhook Error Handling

⌘I

Explorium AgentSource

Partners

Check Webhook Connectivity

Authorizations

Body

Response