Execute Webhook - Guilded Client

Send a message or create a list item using a webhook, depending on its channel type.

For list items, text is extracted from content and embeds and inserted into the item's message, then the full body of the payload is duplicated as the item's note as it would appear for a normal message.

INFO

This endpoint no longer accepts GitHub payloads. For a substitute, see guilded-webhook-proxy, a community project.

application/json: Standard JSON body for normal messages or list items without attachments.

multipart/form-data: Form body for creating a message or list item with attachments. To send embeds with this content type, you must use payload_json as a stringified embeds key is not properly validated.

Request

Path Params

Body Params application/json

Example

{
    "content": "string",
    "embeds": [
        {
            "title": "string",
            "description": "string",
            "url": "string",
            "color": 0,
            "timestamp": "string",
            "footer": {
                "text": "string",
                "icon_url": "string",
                "iconUrl": "string"
            },
            "thumbnail": {
                "url": "string"
            },
            "image": {
                "url": "string"
            },
            "author": {
                "name": "string",
                "url": "string",
                "icon_url": "string",
                "iconUrl": "string"
            },
            "fields": [
                {
                    "name": "string",
                    "value": "string",
                    "inline": true
                }
            ]
        }
    ],
    "username": "string",
    "avatar_url": "http://example.com"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Message or list item created successfully

application/json

Body

Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "channelId": "00000000-0000-0000-0000-000000000000",
    "content": {
        "object": "value",
        "document": {
            "object": "document",
            "data": {
                "profile": {
                    "name": "shay",
                    "profilePicture": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/WebhookThumbnail/3626a9cdc1020a98bd6c1724049c89a8-Full.webp?w=160&h=160"
                },
                "hiddenEmbedUrls": {
                    "{url}": false
                }
            },
            "nodes": [
                {
                    "object": "block",
                    "type": "markdown-plain-text",
                    "data": {
                        "isEmbedMessage": false,
                        "embeds": [
                            {
                                "title": "string",
                                "description": "string",
                                "url": "string",
                                "color": 0,
                                "timestamp": "string",
                                "footer": {
                                    "text": "string",
                                    "icon_url": "string",
                                    "iconUrl": "string"
                                },
                                "thumbnail": {
                                    "url": "string"
                                },
                                "image": {
                                    "url": "string"
                                },
                                "author": {
                                    "name": "string",
                                    "url": "string",
                                    "icon_url": "string",
                                    "iconUrl": "string"
                                },
                                "fields": [
                                    {
                                        "name": "string",
                                        "value": "string",
                                        "inline": true
                                    }
                                ]
                            }
                        ],
                        "url": "string",
                        "createdBy": "string",
                        "oldName": "string",
                        "newName": "string",
                        "type": "channel-renamed"
                    },
                    "nodes": [
                        {
                            "object": "text",
                            "type": "mention",
                            "data": {
                                "mention": {
                                    "type": "role",
                                    "matcher": "string",
                                    "name": "string",
                                    "nickname": true,
                                    "color": "string",
                                    "id": "string",
                                    "sortOrder": 0
                                },
                                "reaction": {
                                    "id": 0,
                                    "customReactionId": 0,
                                    "customReaction": {
                                        "id": 761262,
                                        "name": "frog-donut",
                                        "png": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
                                        "webp": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
                                        "apng": null
                                    }
                                },
                                "channel": {
                                    "id": "string"
                                },
                                "href": "string"
                            },
                            "leaves": [
                                {
                                    "object": "leaf",
                                    "text": "string",
                                    "marks": [
                                        {
                                            "data": {},
                                            "object": "mark",
                                            "type": "bold"
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "": "string"
                }
            ]
        }
    },
    "type": "default",
    "createdBy": "Ann6LewA",
    "createdAt": "2019-08-24T14:15:22Z",
    "webhookId": "00000000-0000-0000-0000-000000000000",
    "isOptimistic": true,
    "isPrivate": false,
    "isSilent": false,
    "repliesToIds": [
        "00000000-0000-0000-0000-000000000000"
    ],
    "guildedClientId": "00000000-0000-0000-0000-000000000000"
}