Webhooks Beta

webhook.get

Request nach den Details der im Account integrierten Webhooks


KEINE VERFÜGBAREN FILTER

Beispielrequest

{
    "SERVICE": "webhook.get"
}

RESPONSE (Liste der registrierten Webhooks)
Tags Beschreibung
WEBHOOK_ID ID des Webhooks
ENDPOINT Adresse des Webhook-Endpoints
TYPE Typ des Webhook-Endpoints
EVENTS Events die dem Endpoint zugeordnet sind

Beispielresponse

{
  "REQUEST": {
    "SERVICE": "webhook.get"
  },
  "RESPONSE": {
    "WEBHOOKS": [
      {
        "WEBHOOK_ID": "15",
        "ENDPOINT": "http://endpoint/url",
        "TYPE": "url",
        "EVENTS": "customer.created,customer.updated"
      },
      {
        "WEBHOOK_ID": "16",
        "ENDPOINT": "http://endpoint2/url",
        "TYPE": "url",
        "EVENTS": "invoice.created,invoice.completed,estimate.created,estimate.updated"
      }
    ]
  }
}

webhook.create

Request zum Anlegen eines Webhooks


DATA
Tags Description
TYPE Typ des Endpoints: "url" | "email". (Derzeit ist nur "url" verfügbar)
ENDPOINT Adresse des Endpoints mit gültigem URL oder E-Mailformat.
EVENTS Daten (Comma-separated values) der Events die dem Endpoint zugeordnet werden sollen:
customer.created
customer.updated
customer.deleted
invoice.created
invoice.completed
invoice.canceled
estimate.created
estimate.updated
contact.created
contact.updated
contact.deleted

Beispielrequest

{
  "REQUEST": {
    "SERVICE": "webhook.create"
  },
  "DATA": {
    "TYPE": "url",
    "ENDPOINT": "http://endpoint/url",
    "EVENTS": "customer.created,customer.updated"
  }
}

RESPONSE
Tags Beschreibung
STATUS Status des Requests.
WEBHOOK_ID ID des erstellten Webhooks.

Beispielresponse

{
  "REQUEST": {
    "SERVICE": "webhook.create"
  },
  "DATA": {
    "TYPE": "url",
    "ENDPOINT": "http://endpoint/url",
    "EVENTS": "customer.created,customer.updated"
  },
  "RESPONSE": {
    "RESPONSE": {
      "STATUS": "success",
      "WEBHOOK_ID": 15
    }
  }
}

webhook.delete

Request zum Löschen eines Webhooks


DATA
Tags Beschreibung
WEBHOOK_ID ID des zu löschenden Webhooks.

Beispielrequest

{
  "REQUEST": {
    "SERVICE": "webhook.delete"
  },
  "DATA": {
    "WEBHOOK_ID": "15"
  }
}

RESPONSE (Liste der registrierten Webhooks)
Tags Beschreibung
STATUS Status des Requests.

Beispielresponse

{
  "REQUEST": {
    "SERVICE": "webhook.delete"
  },
  "DATA": {
    "WEBHOOK_ID": "15"
  },
  "RESPONSE": {
    "RESPONSE": {
      "STATUS": "success"
    }
  }
}

Benachrichtigungen

Die Objekte die an Endpoints weitergegeben werden folgen dem JSON-Format und beinhalten die folgenden Informationen:

id : ID der Benachrichtigung
type : Name des Events das die Benachrichtigung ausgelöst hat
Objects : "customer" , "invoice" , "estimate" Objekte und deren Details
created : Timestamp der Benachrichtigung


Benachrichtungsobjekte und deren Attribute

Customer

customer_id
customer_number
days_for_payment
created
payment_type
bank_name
bank_account_number
bank_code
bank_account_owner
bank_iban
bank_bic
bank_account_mandate_reference
show_payment_notice
account_receivable
customer_type
top
newsletter_optin
organization
position
academic_degree
salutation
first_name
last_name
address
address_2
zipcode
city
country_code
secondary_address
phone
phone_2
fax
mobile
email
website
vat_id
currency_code
lastupdate
tags

Contact

contact_id
customer_id
organization
position
salutation
first_name
last_name
address
address_2
zipcode
city
country_code
secondary_address
phone
phone_2
fax
mobile
email
vat_id
currency_code
comment
created
lastupdate
tags

Invoice

invoice_id
type
customer_id
customer_number
customer_costcenter_id
project_id
currency_code
delivery_date
invoice_title
cash_discount_percent
cash_discount_days
sub_total
vat_total
vat_items
items
total
organization
note
salutation
first_name
last_name
address
address_2
zipcode
city
payment_type
bank_name
bank_account_number
bank_code
bank_account_owner
bank_iban
bank_bic
country_code
vat_id
template_id
invoice_number
introtext
paid_date
is_canceled
invoice_date
due_date
payment_info
lastupdate
document_url

Estimate

estimate_id
state
customer_id
customer_number
customer_costcenter_id
project_id
organization
salutation
first_name
last_name
address
address_2
zipcode
city
invoice_title
payment_type
bank_name
bank_account_number
bank_code
bank_account_owner
bank_iban
bank_bic
country_code
vat_id
currency_code
template_id
estimate_number
introtext
estimate_date
due_date
sub_total
vat_total
vat_items
items
total
document_url

Beispielbenachrichtigung für invoice.created

{
  "id": 11,
  "type": "invoice.created",
  "created": "2016-03-02 17:37:13",
  "invoice": {
    "invoice_id": "14566",
    "type": "outgoing",
    "customer_id": "2",
    "customer_number": "2",
    "customer_costcenter_id": "0",
    "project_id": "0",
    "currency_code": "EUR",
    "delivery_date": "Leistungszeitraum entspricht Rechnungsdatum.",
    "invoice_title": "One more time",
    "cash_discount_percent": "0.00",
    "cash_discount_days": "0",
    "sub_total": 80,
    "vat_total": 15.2,
    "vat_items": [
      {
        "vat_percent": "19.00",
        "complete_net": 80,
        "vat_value": 15.2
      }
    ],
    "items": [
      {
        "invoice_item_id": "18",
        "article_number": "",
        "description": "Produkt",
        "quantity": "1.0000",
        "unit_price": "80.00000000",
        "vat_percent": "19.00",
        "vat_value": 15.2,
        "complete_net": 80,
        "complete_gross": 95.2,
        "sort_order": 1
      }
    ],
    "total": 95.2,
    "organization": "",
    "note": "",
    "salutation": "",
    "first_name": "John",
    "last_name": "Mustemann",
    "address": "Inheidener str. 12",
    "address_2": "",
    "zipcode": "",
    "city": "Frankfurt",
    "payment_type": "1",
    "bank_name": "",
    "bank_account_number": "",
    "bank_code": "",
    "bank_account_owner": "",
    "bank_iban": "",
    "bank_bic": "",
    "country_code": "DE",
    "vat_id": "",
    "template_id": "1",
    "invoice_number": "7",
    "introtext": "wir erlauben uns f\u00fcr unsere Bem\u00fchungen folgende Positionen in Rechnung zu stellen.",
    "paid_date": "0000-00-00 00:00:00",
    "is_canceled": "0",
    "invoice_date": "2016-03-02",
    "due_date": "2016-03-16 00:00:00",
    "payment_info": "",
    "lastupdate": "2016-03-02 18:37:10",
    "document_url": "http:\/\/mydev.fastbill.com\/download\/iGNwBuGMEknEXll.9k-1oOgskmlsdmvshdu"
  },
  "customer": {
    "customer_id": "2",
    "customer_number": "2",
    "days_for_payment": "14",
    "created": "2016-03-02 15:26:57",
    "payment_type": "1",
    "bank_name": "",
    "bank_account_number": "",
    "bank_code": "",
    "bank_account_owner": "",
    "bank_iban": "",
    "bank_bic": "",
    "bank_account_mandate_reference": "",
    "show_payment_notice": "1",
    "account_receivable": "",
    "customer_type": "consumer",
    "top": "0",
    "newsletter_optin": "1",
    "organization": "",
    "position": "",
    "academic_degree": "",
    "salutation": "",
    "first_name": "John",
    "last_name": "Mustermann",
    "address": "Inheidener str. 12",
    "address_2": "",
    "zipcode": "",
    "city": "Frankfurt",
    "country_code": "DE",
    "secondary_address": "",
    "phone": "",
    "phone_2": "",
    "fax": "",
    "mobile": "",
    "email": "",
    "website": "",
    "vat_id": "",
    "currency_code": "EUR",
    "lastupdate": "2016-03-02 15:58:04",
    "tags": ""
  }
}

                
support@fastbill.com
© 2016 FastBill GmbH