List webhook deliveries

curl --request GET \
  --url https://app.microcrop.app/api/organizations/me/webhook/deliveries \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.microcrop.app/api/organizations/me/webhook/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.microcrop.app/api/organizations/me/webhook/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.microcrop.app/api/organizations/me/webhook/deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.microcrop.app/api/organizations/me/webhook/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "deliveries": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "event": "<string>",
        "url": "<string>",
        "status": "PENDING",
        "attempts": 123,
        "responseStatus": 123,
        "lastError": "<string>",
        "deliveredAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123,
    "page": 123,
    "limit": 123
  }
}

GET

organizations

webhook

deliveries

List webhook deliveries

curl --request GET \
  --url https://app.microcrop.app/api/organizations/me/webhook/deliveries \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.microcrop.app/api/organizations/me/webhook/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.microcrop.app/api/organizations/me/webhook/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.microcrop.app/api/organizations/me/webhook/deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.microcrop.app/api/organizations/me/webhook/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "deliveries": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "event": "<string>",
        "url": "<string>",
        "status": "PENDING",
        "attempts": 123,
        "responseStatus": 123,
        "lastError": "<string>",
        "deliveredAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123,
    "page": 123,
    "limit": 123
  }
}

Authorizations

x-api-key

string

header

required

Query Parameters

status

enum<string>

Available options:

PENDING,

DELIVERED,

FAILED

page

integer

default:1

Required range: x >= 1

limit

integer

default:50

Required range: 1 <= x <= 100

Response

200 - application/json

success

boolean

Example:

true

data

object

Show child attributes

Overview

Endpoints

List webhook deliveries

Authorizations

Query Parameters

Response