{"openapi":"3.0.0","info":{"title":"Public Sender API","version":"1.0","description":"Sender API uses a separate api key. If you don’t have one, head over to our support section."},"servers":[{"url":"https://sender.dialogapi.no"}],"security":[{"apikey":[]}],"paths":{"/public/v1/webhooks":{"get":{"summary":"List all webhooks","tags":["Webhooks"],"description":"Webhooks get delivered as JSON, with current fields: ua_browser, ua_version, ua_platform, ua_device, ip, sending_id, external_id, subscriber_id, client_id, link_id","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"event":{"type":"string"},"created_at":{"type":"string"}}}}}}}}},"post":{"summary":"Create new webhook","tags":["Webhooks"],"description":"Webhooks get delivered as JSON, with current fields: ua_browser, ua_version, ua_platform, ua_device, ip, sending_id, external_id, subscriber_id, client_id, link_id","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","event"],"properties":{"url":{"type":"string"},"event":{"type":"string","enum":["delivered","opened","clicked","bounced","unsubscribed"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"event":{"type":"string"},"created_at":{"type":"string"}}}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/public/v1/webhooks/{id}":{"delete":{"summary":"Delete webhook","tags":["Webhooks"],"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook ID","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success"},"404":{"description":"Webhook not found"}}}},"/public/v1/sendings":{"post":{"summary":"Create new sending","tags":["Sendings"],"description":"Use either recipient_pickup_url or list_ids or recipients(max 3000 recipients)\n<a href=\"https://sender.dialogapi.no/sample.json\" target=_blank>View sample file(max 1MB)</a>","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipient_pickup_url","recipients","list_ids","subject","from_name","from_email","replyto_email","mailbody_text","mailbody"],"properties":{"recipient_pickup_url":{"type":"string"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"custom_fields":{"type":"object"}}}},"list_ids":{"type":"array","items":{"type":"integer"}},"tags":{"type":"array","items":{"type":"string"}},"external_id":{"type":"string"},"client_id":{"type":"string"},"subject":{"type":"string"},"from_name":{"type":"string"},"from_email":{"type":"string"},"replyto_email":{"type":"string"},"mailbody_text":{"type":"string"},"mailbody":{"type":"string"},"tracking_mode":{"type":"string","enum":["standard","count","disabled"]},"anonymize_after":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success, returns sending_id","content":{"application/json":{"schema":{"type":"integer"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/public/v1/sendings/{id}":{"get":{"summary":"Get sending stats","tags":["Sendings"],"parameters":[{"name":"id","in":"path","required":true,"description":"Sending ID","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"unique_clicks":{"type":"integer"},"clicks":{"type":"integer"},"opens":{"type":"integer"},"bounce":{"type":"integer"},"unsubscribes":{"type":"integer"},"sent":{"type":"integer"}}}}}},"404":{"description":"Sending not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}},"components":{"securitySchemes":{"apikey":{"type":"http","scheme":"basic"}}}}