Retrieve a webhook delivery

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/webhooks/whk_5f2c9a1e7b3d4c6f8a0e1b2d3c4f5a6b" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.webhooks().getWebhook("whk_5f2c9a1e7b3d4c6f8a0e1b2d3c4f5a6b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Webhooks.GetWebhookAsync("whk_5f2c9a1e7b3d4c6f8a0e1b2d3c4f5a6b");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Webhooks().GetWebhook(context.Background(), "whk_5f2c9a1e7b3d4c6f8a0e1b2d3c4f5a6b", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

webhooks

{webhook_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/webhooks/whk_5f2c9a1e7b3d4c6f8a0e1b2d3c4f5a6b" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.webhooks().getWebhook("whk_5f2c9a1e7b3d4c6f8a0e1b2d3c4f5a6b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Webhooks.GetWebhookAsync("whk_5f2c9a1e7b3d4c6f8a0e1b2d3c4f5a6b");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Webhooks().GetWebhook(context.Background(), "whk_5f2c9a1e7b3d4c6f8a0e1b2d3c4f5a6b", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Pass the whk_ id the delivery carries as webhook_id. No endpoint lists deliveries, so keep the id from each one. An unknown id returns 404 with the code resource_not_found.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

webhook_id

string

required

The delivery's id: whk_ followed by 32 characters.

Response

The webhook delivery.

Guides

API reference

Authorizations

Path Parameters

Response