Webhooks

When a seller onboards, updates, or deletes themselves with imin, we will send you an event payload to your registered webhook.

Register webhook

In order to register your webhook URLs and auth with us, please contact us directly.

Payload

The payloads for the different Seller Onboarding actions are as follows:

Onboard

{
   "context": ["https://schema.org", "https://imin.co"],
   "type": "CreateAction",
   "agent": {
      "type": "Organization",
      "id": "{{ sellerId }}"
   },
   "result": {
      "type": "imin:SellerOnboard",
      "imin:stripeNeeded": false,
      "imin:termsAgreed": true
   }
}

Update

{
   "context": ["https://schema.org", "https://imin.co"],
   "type": "UpdateAction",
   "agent": {
      "type": "Organization",
      "id": "{{ sellerId }}"
   },
   "result": {
      "type": "imin:SellerOnboard",
      "imin:stripeNeeded": true,
      "imin:termsAgreed": true
   }
}

Delete

{
   "context": ["https://schema.org", "https://imin.co"],
   "type": "DeleteAction",
   "agent": {
      "type": "Organization",
      "id": "{{ sellerId }}"
   }
   "object": {
      "type": "imin:SellerOnboard"
   }
}