Create Message With Webhook

Request

Path Params

webhookId

string

required

webhookToken

string

required

Header Params

Content-Type

string

required

Default:

application/json

Body Params application/json

username

string

required

Override the default username of the webhook

content

string | null

optional

Content of the message (Markdown supported)

<= 2000 characters

embeds

array[object (Message Embed) {8}]

optional

List of embeds included with the message

<= 5 items

title

string | null

required

Title of the embed

<= 16 characters

description

string | null

required

Description text for the embed (Markdown supported)

<= 1024 characters

url

string <uri> | null

optional

URL associated with the embed

color

number | null

required

Color code for the embed, represented in hexadecimal format

author

object | null

required

Contains information about the author of the embed

thumbnail

object | null

required

Contains information about the thumbnail image

image

object | null

required

Contains information about the image

footer

object | null

required

Contains information about the footer

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.teamly.one/api/v1/webhooks//' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

success

boolean

required

message

object (Message)

required

id

string

required

Unique identifier for the message

channelId

string

required

ID of the channel where the message was posted

type

string

required

Type of the message (e.g., 'text' for a text message)

content

string | null

required

Content of the message (Markdown supported)

<= 2000 characters

attachments

array [object] | null

optional

Attachments for the message (may be empty)

<= 5 items

createdBy

object (User)

required

User who created the message

editedAt

string <date-time>

optional

Timestamp of when the message was last edited

replyTo

string

optional

ID of the message being replied to, or null if the message is not a reply

embeds

array[object (Message Embed) {8}]

required

List of embeds included with the message

<= 5 items

emojis

array [object {1}]

optional

reactions

array [object {3}]

optional

nonce

string

optional

Unique identifier for this message instance, used to prevent duplicates

createdAt

string <date-time>

required

Timestamp of when the message was created

mentions

object

required

Information about users mentioned in the message

Example

{
  "success": true,
  "message": {
    "id": "string",
    "channelId": "string",
    "type": "string",
    "content": "string",
    "attachments": [
      {}
    ],
    "createdBy": {
      "id": "string",
      "username": "string",
      "subdomain": "string",
      "profilePicture": null,
      "banner": null,
      "bot": false,
      "presence": 0,
      "badges": [],
      "userStatus": {
        "content": null,
        "emojiId": null
      },
      "userRPC": {
        "type": null,
        "name": null,
        "id": null,
        "startedAt": null
      },
      "connections": [],
      "createdAt": "CURRENT_TIMESTAMP",
      "lastOnline": "CURRENT_TIMESTAMP",
      "system": false
    },
    "editedAt": "2019-08-24T14:15:22Z",
    "replyTo": "string",
    "embeds": [
      {
        "title": "string",
        "description": "string",
        "url": "http://example.com",
        "color": 0,
        "author": {
          "name": "string",
          "icon_url": "http://example.com"
        },
        "thumbnail": {
          "url": "http://example.com"
        },
        "image": {
          "url": "http://example.com"
        },
        "footer": {
          "text": "string",
          "icon_url": "http://example.com"
        }
      }
    ],
    "emojis": [
      {
        "emojiId": "string"
      }
    ],
    "reactions": [
      {
        "emojiId": "string",
        "count": 0,
        "users": [
          {
            "userId": "string",
            "timestamp": "2019-08-24T14:15:22Z"
          }
        ]
      }
    ],
    "nonce": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "mentions": {
      "users": [
        "string"
      ]
    }
  }
}