Passer au contenu principal
POST
/
v2
/
private
/
webhooks
/
subscribe
Subscribe Webhook
curl --request POST \
  --url https://api.crowdchange.dev/v2/private/webhooks/subscribe \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "lang": "<string>",
  "events": [
    "<string>"
  ]
}
'
{
  "id": 1,
  "url": "https://demo.crowdchange.test/webhooks/handle",
  "signing_secret": "whsec_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ab",
  "language": "en",
  "created_at": "2024-01-01 16:00:03",
  "events": [
    {
      "id": 1,
      "name": "fundraiser_created",
      "created_at": "string"
    }
  ]
}

​
Body

​
url
string
requis
URL to subscribe. Provided URL should return 200 HTTP-code in order to be subscribed.
​
lang
string
Webhook locale. Allowed values: en, fr Default: en
​
events
string[]
Events for subscription.

​
Response

​
id
integer
Webhook ID.
​
url
string
Webhook URL.
​
signing_secret
string
Webhook-specific secret used to verify CrowdChange-Webhook-Signature on outbound deliveries. Store this value securely.
​
language
string
Webhook language. Allowed values: en, fr
​
created_at
string
Webhook creation date.
​
events
object[]
List of subscribed events.
Other responses
StatusDescription
400URL is not available (does not return 200 HTTP-code)
403Forbidden
{
  "id": 1,
  "url": "https://demo.crowdchange.test/webhooks/handle",
  "signing_secret": "whsec_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ab",
  "language": "en",
  "created_at": "2024-01-01 16:00:03",
  "events": [
    {
      "id": 1,
      "name": "fundraiser_created",
      "created_at": "string"
    }
  ]
}