Retrieve a webhook endpoint - YCloud Docs

{
  "id": "wh627c8640675de8fc689ab9d9",
  "url": "https://httpbin.org/anything?tag=api",
  "enabledEvents": [
    "whatsapp.message.updated",
    "whatsapp.inbound_message.received"
  ],
  "eventProperties": [
    {
      "event": "contact.attributes_changed",
      "properties": [
        "attr1",
        "attr2"
      ]
    }
  ],
  "description": "My first webhook endpoint.",
  "status": "active",
  "secret": "whsec_abc4147651944f02baf3be1eb45d33f1",
  "createTime": "2022-06-01T12:00:00.000Z",
  "updateTime": "2022-06-01T12:00:00.000Z"
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

GET

https://api.ycloud.com/v2

/

webhookEndpoints

/

{id}

{
  "id": "wh627c8640675de8fc689ab9d9",
  "url": "https://httpbin.org/anything?tag=api",
  "enabledEvents": [
    "whatsapp.message.updated",
    "whatsapp.inbound_message.received"
  ],
  "eventProperties": [
    {
      "event": "contact.attributes_changed",
      "properties": [
        "attr1",
        "attr2"
      ]
    }
  ],
  "description": "My first webhook endpoint.",
  "status": "active",
  "secret": "whsec_abc4147651944f02baf3be1eb45d33f1",
  "createTime": "2022-06-01T12:00:00.000Z",
  "updateTime": "2022-06-01T12:00:00.000Z"
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

id

string

required

ID of the webhook endpoint.

Example:

"wh627c8640675de8fc689ab9d9"

Response

Successfully retrieved the webhook endpoint.

id

string

required

Unique ID for the object.

Example:

"wh627c8640675de8fc689ab9d9"

url

string

The URL of the webhook endpoint.

Example:

"https://httpbin.org/anything?tag=api"

enabledEvents

string[]

The list of events to enable for this endpoint.

Example:

[
  "whatsapp.message.updated",
  "whatsapp.inbound_message.received"
]

eventProperties

object[]

Optional configuration for event properties in webhook payloads. Specifies which properties should be included for specific event types. When enabledEvents contains contact.attributes_changed, this field is required and must contain at least one event property configuration for that event type.

Show child attributes

Example:

[
  {
    "event": "contact.attributes_changed",
    "properties": ["attr1", "attr2"]
  }
]

description

string

An optional description of what the webhook is used for.

Example:

"My first webhook endpoint."

status

enum<string>

Webhook endpoint status.

active: Indicates that the webhook endpoint is active, and will receive notifications of events monitored.
disabled: Indicates that the webhook endpoint is disabled, and will not receive notifications.
pending: Indicates that the webhook endpoint is pending, and will not receive notifications. If a webhook endpoint fails to receive notifications frequently, it changes to pending.

Available options:

active,

disabled,

pending

secret

string

The endpoint's secret, used to generate webhook signatures.

Example:

"whsec_abc4147651944f02baf3be1eb45d33f1"

createTime

string<date-time>

The time at which this object was created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

Example:

"2022-06-01T12:00:00.000Z"

updateTime

string<date-time>

The time at which this object was updated, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

Example:

"2022-06-01T12:00:00.000Z"