Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Webhooks

Webhook to notify when a contract is created.

postWebhookcontract-created

Headers

X-Rillet-Signaturestring required

Signature of the webhook event. Computed using HMAC-SHA256 and AES encrypted with the configured webhook token. The contents of the body are prefixed with the timestamp and id before hashing.

X-Rillet-Timestampstring date-time required

Timestamp of the webhook event in ISO-8601 format

X-Rillet-Idstring uuid required

ID of the webhook event

X-Rillet-Entitystring required

Entity type of the webhook event

X-Rillet-Eventstring required

Event type of the webhook event

Payload

idstring uuid required
customer_idstring uuid required
subsidiary_idstring uuid required
namestring required
status'ACTIVE' | 'IN_EFFECT' | 'CANCELLED' | 'ENDED' | 'AMENDED' required
start_datestring date required
end_datestring date
close_datestring date required

Example payload

{
  "name": "New API Contract",
  "items": [
    {
      "price": {
        "amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "interval_months": 1
      },
      "quantity": 1,
      "total_value": {
        "amount": "1.01",
        "currency": "USD"
      },
      "discount": {
        "amount_off": {
          "amount": "1.01",
          "currency": "USD"
        }
      },
      "tax_rate": {
        "tax_amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "country": "US"
      },
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ]
    }
  ],
  "invoicing": {
    "day": 1
  },
  "total_value": {
    "amount": "1.01",
    "currency": "USD"
  },
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ],
  "exchange_rate": {
    "base": "USD",
    "target": "USD"
  },
  "usage_commitment": {
    "amount": {
      "amount": "1.01",
      "currency": "USD"
    },
    "revenue_account": "11112"
  }
}

Response

OK

string required

A placeholder indicating a response from a webhook. The contents of this response are ignored.