/user-webhook/

Register a webhook to be notified when jobs change status. The signing secret is returned once, on creation - store it securely.

Body Params
string
required
length ≤ 254

Email to receive notifications of repeated failures

string
enum
required
  • report_job - Report Job
  • ancestry_job - Ancestry Job
  • pgx_job - Pgx Job
  • dna_kit_job - Dna Kit Job
  • longevity_screener_job - Longevity Screener Job
  • order_job - Order Job
  • bio_chemistry_job - Bio Chemistry Job
  • carrier_status_job - Carrier Status Job
  • lab_ocr_job - Lab Ocr Job
  • genome_file_job - Genome File Job
  • clinical_overview_job - Clinical Overview Job
  • custom_snp_report_job - Custom Snp Report Job
  • hair_loss_job - Hair Loss Job
  • snp_file_job - Snp File Job
  • acmg_job - Acmg Job
  • hla_job - Hla Job
  • functional_variants_job - Functional Variants Job
  • wgs_pgx_job - Wgs Pgx Job
  • rare_variants_job - Rare Variants Job
  • action_plan_job - Action Plan Job
  • results_ready_job - Results Ready Job
uri
required
length ≤ 200

URL to send the webhook payload to

string
enum
  • result - Result
  • subscription - Subscription
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json