Developer Docs

Developer Docs

  • Getting Started
  • SubscriptionJS
  • REST API
  • Webhooks
  • Code Samples
  • UseCases
  • Request a Demo

›Customer and Contract

General

  • Introduction
  • Security & Reliability

Customer and Contract

  • Order Succeeded
  • Contract Created
  • Contract Changed
  • Contract Data Changed
  • Contract Deleted
  • Contract Cancelled
  • Customer Created
  • Customer Changed
  • Customer Deleted
  • Customer Locked
  • Customer Unlocked
  • Dunning Created
  • Invoice Created
  • Invoice Corrected
  • Recurring Billing Approaching
  • Trial End Approaching
  • AccountCreated (deprecated)

Payment

  • Payment Bearer Expiring
  • Payment Bearer Expired
  • Debit Auth Cancelled
  • Payment Data Changed
  • Payment Escalated
  • Payment Escalation Reset
  • Payment Succeeded
  • Payment Failed
  • Payment Process Status Changed
  • Payment Registered

Plan

  • Plan Created
  • Plan Changed
  • Plan Deleted

Planvariant

  • Planvariant Created
  • Planvariant Changed
  • Planvariant Deleted

Components

  • Component Created
  • Component Changed
  • Component Deleted

Reporting

  • Report Succeeded
  • Report Failed
  • Accounting Export File Created

Contract Created

Sent when a contract was created either via self-service or Admin UI.

Typical Scenario

Upon receving this hook, you'll want to query the billwerk API for the given contract to create a new account in your system and send a welcome email. To do so, you might have to also fetch the customer whose id is given in the contract.

HTTP/1.1
POST /billwerk-hook
Host: example.com
Content-Type: application/json

{
    "ContractId":"6298a006e636b694d807080f",
    "CustomerId":"6298a006e636b694d8070809",
    "Event":"ContractCreated",
    "EntityId":"62148e3c0c14e1609e9ca5c1"
}
Last updated on 6/2/2022 by Przemek Dawidowicz
← Order SucceededContract Changed →
Docs
Getting StartedAPI Reference
Resource
Help CenterSupportBlogTutorials
Start with billwerk
Test for free
Request a Demo
Already started?
billwerk Sandboxbillwerk Production
billwerk GmbH
© Made with ❤ in Germany for Europe by billwerk GmbH | 2022
Imprint
|
Data Privacy Rules
|
Disclaimer