För att ta emot webhooks, gå till Admin → Inställningar → Utvecklare och lägg till en endpoint. För att utforska och testa webhooks rekommenderar vi att använda ett verktyg som Requestbin eller Ngrok/LocalCan på i din lokala utvecklingsmiljö.

Alla webhooks skickas som POST requests med en JSON body till din endpoint.
Kontrollera attributet name för att se vilken typ av event det är.

Säkerhet

Varje webhook vi skickar innehåller en header som heter Octany-Signature, vilken innehåller en hash av payload. Den använder HMAC med en unik secret för din endpoint. Du kan validera anropet genom att matcha payload med din secret mot signature i headern.

Flöde

Dessa webhooks triggas när någon registrerar sig för en ny subscription.

Om någon gör ett enstaka köp triggas följande webhooks:

Händelser

subscription.created

Detta event skickas när en ny subscription har skapats i systemet.

{
  "id": "59958608-8e4d-4795-b7b6-91512359c935",
  "name": "subscription.created",
  "account": 1421,
  "created_at": "2023-10-20T09:01:43+00:00",
  "data": {
    "id": 70212202,
    "vat": 2500,
    "price": 34900,
    "status": "active",
    "ends_at": null,
    "product": {
      "id": 1225,
      "name": "Pro",
      "type": "month",
      "price": 34900,
      "currency": "sek",
      "vat_rate": 2500
    },
    "currency": "sek",
    "customer": {
      "id": 452512733,
      "name": "John Doe",
      "type": "company",
      "created_at": "2023-10-20T09:01:43+00:00",
      "updated_at": "2023-10-20T09:01:43+00:00",
      "vat_number": null,
      "archived_at": null
    },
    "renews_at": "2023-10-20T09:01:43+00:00",
    "customer_id": 452512733,
    "billing_method": {
      "name": "faktura",
      "type": "fortnox",
      "email": "[email protected]",
      "person": {
        "email": "[email protected]",
        "phone": false,
        "locale": "sv",
        "last_name": "Persson",
        "first_name": "Peter",
        "personal_identity_number": null
      },
      "address": {
        "zip": "116 53",
        "city": "Stockholm",
        "line1": "Sveavägen 11",
        "line2": null,
        "country": "SE",
        "created_at": "2023-10-20T09:01:43+00:00",
        "updated_at": "2023-10-20T09:01:43+00:00"
      },
      "company": {
        "name": "Example Company",
        "vat_number": "SE556742219001"
      }
    },
    "reference_id": null,
    "reference_name": null
  }
}

subscription.renewed

Skickas varje gång en förnyelse av subscription har genomförts. Innehåller exakt samma payload som subscription.created.

subscription.cancelled

När en subscription blir avslutad. Observera att detta event triggas både när en kund eller admin avslutar prenumerationen. Det kan fortfarande finnas tid kvar på prenumerationen innan den avslutas.

Exempel

Jane registrerar sig den 14 februari och hennes prenumeration kommer att förnyas den 14:e varje månad. Hon avslutar sin prenumeration den 24 juli, vilket triggar subscription.cancelled webhook.

I payloaden ser du att ends_at är 14 augusti och att renews_at är null, eftersom prenumerationen inte kommer att förnyas igen. Innehåller exakt samma payload som subscription.created.

order.confirmed

Detta event skickas för engångsköp och återkommande betalningar som görs via Octany. Eventet skickas omedelbart för nya orders. Innehåller exakt samma payload som order.paid.

order.paid

Detta event skickas för engångsbetalningar och återkommande betalningar som görs via Octany. Eventet skickas omedelbart för kort- och Swish betalningar. För betalsätt med senare betalning som faktura skickas det först när den faktiska fakturan har betalats.

{
  "id": "114d8fd9-862a-4832-a8d1-422bf4a778a7",
  "name": "order.paid",
  "account": 1421,
  "created_at": "2023-10-20T09:01:43+00:00",
  "data": {
    "id": 193468423,
    "customer_id": 449739128,
    "total": 34900,
    "total_with_vat": 43625,
    "currency": "sek",
    "reference_id": null,
    "reference_name": null,
    "state": "paid",
    "billing_method": {
      "name": "Swish",
      "type": "swish",
      "email": "[email protected]",
      "person": {
        "email": "[email protected]",
        "phone": "46730401224",
        "locale": "sv",
        "last_name": "Doe",
        "first_name": "Jane",
        "personal_identity_number": null
      },
      "address": null,
      "company": null
    },
    "items": [
      {
        "description": "Snowfire Website",
        "quantity": "1",
        "price": 34900,
        "vat": 2500,
        "product": {
          "id": 1225,
          "name": "Snowfire Website",
          "type": "month",
          "price": 34900,
          "currency": "sek",
          "vat_rate": 2500
        }
      }
    ],
    "customer": {
      "id": 449739128,
      "name": "Jane Doe",
      "type": "person",
      "vat_number": null,
      "archived_at": null
    },
    "delivery": {
      "link": "https://octanyzone.com/1/d/d3b9d060-F8f7-434d-ae77-P616c7a67ba8"
    }
  }
}

Leverans

En order kan inkludera en leverans (delivery). För enstaka filer (PDF, JPG eller URL) kommer kunden att omdirigeras direkt till filen. Vid flera filer får kunden en länk till en webbsida där de kan visa och ladda ner enskilda filer.

Delivery URLs är unika för varje order och ska endast delas med den kund som genomförde köpet. Dessa URLs måste hållas konfidentiella och får inte distribueras till andra.

Relaterade artiklar

Prenumerationer

Order

Produkter

Widget för donationer

Webhooks