Pular para o conteúdo

Get a webhook

Retrieves a single webhook configuration by webhookId.

GET/api/v1/webhooks/{webhookId}

Get sub-tenant webhook by id

Returns one webhook record including URL, sub-tenant, and notification type.

Auth: Bearer Token

Parâmetros de path

1 campo
webhookId●
pathstring

Identifier returned when the webhook was created.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/webhooks/webhook123' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Response

200Webhook returned successfully.
Response body
object
  • dataobjectrequired
    • idstringrequired

      Webhook id.

    • subTenantstringrequired

      Sub-tenant identifier.

    • webhookUrlstringrequired

      Callback URL.

    • typestringrequired

      Notification category.

  • messagestring

    Response message.

  • typestring

    Envelope type.

  • statusCodenumber· nullable

    HTTP status in the envelope.

200 · Webhook returned successfully.
{
  "data": {
    "id": "webhook123",
    "subTenant": "subTenant123",
    "webhookUrl": "https://api.example.com/lina/webhook",
    "type": "CONSENT"
  },
  "message": "",
  "type": "success",
  "statusCode": 200
}

Next steps