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": "award",
"number_of_events": 5,
"event_time": "2023-11-07T05:31:56Z"
}
}
'{
"response_context": {
"correlation_id": "<string>",
"request_status": "success",
"time_took_in_seconds": 123
}
}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": "award",
"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
Headers
Body
null
Show child attributes
Show child attributes
The WebhookSimulationEventType class is an enumeration that represents various types of events
award, closing_office, company_award, cost_cutting, decrease_in_all_departments, decrease_in_customer_service_department, decrease_in_engineering_department, decrease_in_marketing_department, decrease_in_operations_department, decrease_in_sales_department, employee_joined_company, funding_round, hiring_in_creative_department, hiring_in_education_department, hiring_in_engineering_department, hiring_in_finance_department, hiring_in_health_department, hiring_in_human_resources_department, hiring_in_legal_department, hiring_in_marketing_department, hiring_in_operations_department, hiring_in_professional_service_department, hiring_in_sales_department, hiring_in_support_department, hiring_in_trade_department, hiring_in_unknown_department, increase_in_all_departments, increase_in_customer_service_department, increase_in_engineering_department, increase_in_marketing_department, increase_in_operations_department, increase_in_sales_department, ipo_announcement, lawsuits_and_legal_issues, merger_and_acquisitions, new_funding_round, new_investment, new_office, new_partnership, new_product, outages_and_security_breaches, prospect_changed_company, prospect_changed_role, prospect_job_start_anniversary Number of events to generate in simulation (between 1 and 10)
1 <= x <= 10Response
Successful Response
This is base response model for all responses in partner service.
Show child attributes
Show child attributes
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.
success, miss, failure Was this page helpful?