BokaMera.API.Host

<back to all web services

WebhookCreateAgreement

The following routes are available for this service:
POST/webhooks/termsWebhook from prismic

export class WebhookAgreements
{
    public id: string;
    public label: string;
    public documents: string[];

    public constructor(init?: Partial<WebhookAgreements>) { (Object as any).assign(this, init); }
}

export class Releases
{
    public deletion: WebhookAgreements[];

    public constructor(init?: Partial<Releases>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
export class WebhookCreateAgreement
{
    public releases: Releases;
    public documents: string[];
    public secret: string;

    public constructor(init?: Partial<WebhookCreateAgreement>) { (Object as any).assign(this, init); }
}

TypeScript WebhookCreateAgreement DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	releases: 
	{
		deletion: 
		[
			{
				id: String,
				label: String,
				documents: 
				[
					String
				]
			}
		]
	},
	documents: 
	[
		String
	],
	secret: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}