BokaMera.API.Host

<back to all web services

WebhookCreateAgreement

The following routes are available for this service:
POST/webhooks/termsWebhook from prismic
"use strict";
export class WebhookAgreements {
    /** @param {{id?:string,label?:string,documents?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    label;
    /** @type {string[]} */
    documents;
}
export class Releases {
    /** @param {{deletion?:WebhookAgreements[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WebhookAgreements[]} */
    deletion;
}
export class WebhookCreateAgreement {
    /** @param {{releases?:Releases,documents?:string[],secret?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Releases} */
    releases;
    /** @type {string[]} */
    documents;
    /** @type {string} */
    secret;
}

JavaScript WebhookCreateAgreement DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /webhooks/terms HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WebhookCreateAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </documents>
  <releases>
    <deletion>
      <WebhookAgreements>
        <documents xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </documents>
        <id>String</id>
        <label>String</label>
      </WebhookAgreements>
    </deletion>
  </releases>
  <secret>String</secret>
</WebhookCreateAgreement>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />