Webhook blog articles action - OgnianApostolov/builderly-api-docs GitHub Wiki

Model

BlogpostWebhook blogpost_webhook = {
    "title": {
        "type": "string",
        "required": "true"
    },
    "header": {
        "type": "string",
        "required": "true"
    },
    "description": {
        "type": "string",
        "required": "true"
    },
    "medias": [{
        "type": "string",
        "required": "true"
    }],
    "collection": {
        "type": "string",
        "required": "true"
    },
    "publishedAt": {
        "type": "string",
        "required": "true"
    },
    "reference_id": {
        "type": "string",
        "required": "true"
    }
}

Methods

Create new

POST 'https://{{your-builderly-domain}}/webhook/blogpost' req.body required

method: 'POST'
{
    url: 'https://{{your-builderly-domain}}/webhook/blogpost',
    headers: {
        'X-API-KEY': api_key
    },
    json: true,
    body: blogpost_webhook;
}

Responses Success - status 201

{ 
    blogpost_webhook 
}

Error - status 400

{
    error_message
}

Update single

PATCH 'https://{{your-builderly-domain}}/webhook/blogpost'

method: 'PATCH'
{
    url: 'https://{{your-builderly-domain}}/webhook/blogpost',
    headers: {
        'X-API-KEY': api_key
    },
    json: true,
    body: webhook_blogpost
}

Responses Success - status 200

{ 
    webhook_blogpost
}

Error - status 400

{
    error_message
}

Not found - status 404

{}

Delete single

DELETE 'https://{{your-builderly-domain}}/webhook/blogpost'

method: 'DELETE'
{
    url: 'https://{{your-builderly-domain}}/webhook/blogpost',
    headers: {
        'X-API-KEY': api_key
    },
    json: true,
    body: {}
}

Responses Success - status 200

{}

Not found - status 404

{}

Error - status 500

{
    error_message
}