Skip to main content
POST
/
v2
/
webhooks
Example subscription
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "gigs.added"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret"
}
'
{
  "event": "gigs.added",
  "name": "name-for-the-webhook-subscription",
  "data": {
    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "available_from": "2016-04-16T05:32:41Z",
    "available_to": "2023-03-03T00:00:00Z",
    "available_count": 2385,
    "added_count": 6,
    "added_from": "2023-03-02T00:00:00Z",
    "added_to": "2023-03-03T00:00:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.argyle.com/llms.txt

Use this file to discover all available pages before exploring further.

Sent when gigs are added, updated, or removed. If you need to access to gig data as soon as it is available:
  • The gigs.partially_synced webhook is sent when gigs going back a specified number of days prior (starting from the date when the account was added) have been retrieved during initial data retrieval for a newly connected account.
  • The gigs.fully_synced webhook is sent when all gigs have been retrieved during initial data retrieval for a newly connected account.
Because some accounts can contain thousands of gigs, we recommend subscribing to the gigs.partially_synced webhook when especially time-sensitive. The gigs.fully_synced webhook will only be sent when all gig data has been retrieved, which may take up to several hours in these cases.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
string[]
required

gigs.added

​
name
string
required

Your name for the webhook subscription.

​
url
string
required

Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service. Argyle handles URL encoding for webhook URLs. Send the URL in its normal, unencoded form.

​
secret
string

Optional secret used to verify webhooks.

Response

200 - application/json
​
event
string

gigs.added

​
name
string

Name used for the webhook subscription.

​
data
object