Get Webhook Config - Everflow API

Get Webhook Config

curl --request GET \
  --url https://api.eflow.team/v1/networks/webhooks/{webhookId} \
  --header 'X-Eflow-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Eflow-Api-Key': '<api-key>'}};

fetch('https://api.eflow.team/v1/networks/webhooks/{webhookId}', 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://api.eflow.team/v1/networks/webhooks/{webhookId}",
  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-Eflow-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://api.eflow.team/v1/networks/webhooks/{webhookId}"

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

	req.Header.Add("X-Eflow-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://api.eflow.team/v1/networks/webhooks/{webhookId}")

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

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

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

{
  "network_webhook_id": 1,
  "network_id": 1,
  "webhook_types": [
    "affiliate_updated"
  ],
  "http_method": "post",
  "webhook_url": "https://example.com/webhook",
  "description": "My webhook",
  "status": "active",
  "time_created": 1774726693,
  "time_saved": 1774726693
}

GET

/

networks

/

webhooks

/

{webhookId}

Get Webhook Config

curl --request GET \
  --url https://api.eflow.team/v1/networks/webhooks/{webhookId} \
  --header 'X-Eflow-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Eflow-Api-Key': '<api-key>'}};

fetch('https://api.eflow.team/v1/networks/webhooks/{webhookId}', 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://api.eflow.team/v1/networks/webhooks/{webhookId}",
  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-Eflow-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://api.eflow.team/v1/networks/webhooks/{webhookId}"

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

	req.Header.Add("X-Eflow-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://api.eflow.team/v1/networks/webhooks/{webhookId}")

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

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

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

{
  "network_webhook_id": 1,
  "network_id": 1,
  "webhook_types": [
    "affiliate_updated"
  ],
  "http_method": "post",
  "webhook_url": "https://example.com/webhook",
  "description": "My webhook",
  "status": "active",
  "time_created": 1774726693,
  "time_saved": 1774726693
}

Retrieve a single webhook configuration by its ID. Returns the webhook URL, event types, status, and other configuration details.

Authorizations

X-Eflow-Api-Key

string

header

required

The Everflow API key generated from the Control Center > Security.

Path Parameters

webhookId

integer

required

The webhook ID.

Response

200 - application/json

A webhook configuration.

network_webhook_id

integer

Unique webhook ID.

Example:

1

network_id

integer

Network ID.

Example:

1

webhook_types

enum<string>[]

Event types that trigger this webhook.

Available options:

advertiser_created,

advertiser_signed_up,

advertiser_updated,

affiliate_approved_for_offer,

affiliate_created,

affiliate_signed_up,

affiliate_signup_verdict,

affiliate_updated,

offer_created,

offer_updated,

traffic_optimized

Example:

["affiliate_updated"]

http_method

enum<string>

HTTP method used when sending the webhook.

Available options:

get,

post

Example:

"post"

webhook_url

string

The webhook endpoint URL.

Example:

"https://example.com/webhook"

description

string

Optional description for the webhook.

Example:

"My webhook"

status

enum<string>

Webhook status.

Available options:

active,

inactive

Example:

"active"

time_created

integer

Unix timestamp of creation.

Example:

1774726693

time_saved

integer

Unix timestamp of last update.

Example:

1774726693