Webhooks

Create webhook

Registers a new webhook endpoint for the project. Signal will POST a signed JSON payload to the given URL whenever any of the subscribed event types occurs. Each delivery is signed with HMAC-SHA256 using the endpoint’s secret, which is returned once at creation time and never shown again.

Requirements

Permission: webhooks:write.
Project access: the path project must match the API key’s project.
HTTP rate limit: 60 requests per 60 seconds per API key.

POST

projects

{projectId}

webhooks

TypeScript

import { createApolloSignalApiClient } from "@apollo-deploy/signal-sdk";

const signal = createApolloSignalApiClient({ apiKey: "ap_signal_..." });

const result = await signal.webhooks.createWebhook(/* params */);

console.log(result);

import signal "github.com/apollo-deploy/signal-sdk-go"

client := signal.NewClient("ap_signal_...")

result, err := client.Webhooks.CreateWebhook(context.Background() /* params */)
if err != nil {
    log.Fatal(err)
}
fmt.Println(result)

curl --request POST \
  --url https://api.signal.apollodeploy.com/v1/projects/{projectId}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [],
  "url": "<string>",
  "filters": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "secret": "<string>",
  "transformations": [
    {
      "field": "<string>",
      "from": "<string>",
      "template": "<string>",
      "to": "<string>",
      "value": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: [],
    url: '<string>',
    filters: [{field: '<string>', value: '<string>'}],
    name: '<string>',
    secret: '<string>',
    transformations: [
      {
        field: '<string>',
        from: '<string>',
        template: '<string>',
        to: '<string>',
        value: '<string>'
      }
    ]
  })
};

fetch('https://api.signal.apollodeploy.com/v1/projects/{projectId}/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "<string>",
  "enabled": true,
  "events": [
    "<string>"
  ],
  "id": "<string>",
  "name": "<string>",
  "projectId": "<string>",
  "secret": "<string>",
  "updatedAt": "<string>",
  "url": "<string>",
  "filters": [
    {
      "field": "<string>",
      "operator": "eq",
      "value": "<string>"
    }
  ],
  "transformations": [
    {
      "type": "rename_field",
      "field": "<string>",
      "from": "<string>",
      "template": "<string>",
      "to": "<string>",
      "value": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.

Path Parameters

projectId

string

required

The project to register the webhook in.

Body

application/json

Target URL, event types to subscribe to, and optional description.

Webhook destination, subscribed event types, and optional payload processing rules.

events

enum<string>[]

required

Event types delivered to this endpoint.

Available options:

email.sent,

email.delivered,

email.bounced,

email.complained,

email.opened,

email.clicked,

email.failed,

email.rejected,

email.delivery_delayed,

email.suppressed,

email.unsubscribed,

email.read_engaged,

webhook.test

url

string<uri>

required

Public HTTPS delivery URL. Localhost and blocked private-network targets are rejected.

filters

WebhookFilterSerializable · object[]

All filters must match for an event to be delivered.

Show child attributes

name

string

Human-readable endpoint name. Signal generates one when omitted.

secret

string

Optional signing secret. Signal generates one when omitted and returns it in the create response.

transformations

WebhookTransformationSerializable · object[]

Payload transformations applied in list order after filtering.

Show child attributes

Response

Webhook created. The secret field is only present in this response.

createdAt

string

required

enabled

boolean

required

events

string[]

required

string

required

name

string

required

projectId

string

required

secret

string

required

updatedAt

string

required

url

string

required

filters

WebhookFilterSerializable · object[]

Show child attributes

transformations

WebhookTransformationSerializable · object[]

Show child attributes

TypeScript

import { createApolloSignalApiClient } from "@apollo-deploy/signal-sdk";

const signal = createApolloSignalApiClient({ apiKey: "ap_signal_..." });

const result = await signal.webhooks.createWebhook(/* params */);

console.log(result);

import signal "github.com/apollo-deploy/signal-sdk-go"

client := signal.NewClient("ap_signal_...")

result, err := client.Webhooks.CreateWebhook(context.Background() /* params */)
if err != nil {
    log.Fatal(err)
}
fmt.Println(result)

curl --request POST \
  --url https://api.signal.apollodeploy.com/v1/projects/{projectId}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [],
  "url": "<string>",
  "filters": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "secret": "<string>",
  "transformations": [
    {
      "field": "<string>",
      "from": "<string>",
      "template": "<string>",
      "to": "<string>",
      "value": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: [],
    url: '<string>',
    filters: [{field: '<string>', value: '<string>'}],
    name: '<string>',
    secret: '<string>',
    transformations: [
      {
        field: '<string>',
        from: '<string>',
        template: '<string>',
        to: '<string>',
        value: '<string>'
      }
    ]
  })
};

fetch('https://api.signal.apollodeploy.com/v1/projects/{projectId}/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "<string>",
  "enabled": true,
  "events": [
    "<string>"
  ],
  "id": "<string>",
  "name": "<string>",
  "projectId": "<string>",
  "secret": "<string>",
  "updatedAt": "<string>",
  "url": "<string>",
  "filters": [
    {
      "field": "<string>",
      "operator": "eq",
      "value": "<string>"
    }
  ],
  "transformations": [
    {
      "type": "rename_field",
      "field": "<string>",
      "from": "<string>",
      "template": "<string>",
      "to": "<string>",
      "value": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "detail": "<string>",
      "pointer": "<string>"
    }
  ],
  "instance": "<string>",
  "requestId": "<string>"
}

Overview

Emails

Metrics

Projects and email logs

Sending domains

Contacts

Contact properties

Segments

Topics

Suppressions

Webhooks

API key usage

Create webhook

Requirements

Authorizations

Path Parameters

Body

Response