API Reference

Webhook URL

Webhook URL

Two options exist for obtaining resolutions from the SparkAI service.

  • Create the initial engagement request with a webhook URL. The SparkAI service will attempt to POST results to the provided URL on any change of engagement status.
  • A user can poll the engagement API endpoint for status and resolution. This option is always available, even if a webhook URL option was provided.

The webhook URL should be:

  • Well-formed
  • Able to service HTTP POST requests
  • Capable of accepting JSON content
  • Able to respond with a 200 (OK) status code on receipt

SparkAI will attempt the URL 5 times, at 30 second intervals unless a successful request has been made.